# Discovery

## addDevice

Allows you to add individual devices to OpManager for monitoring.

### HTTP Method

`POST`

### API URL

```
https://localhost:8060/api/json/discovery/addDevice?apiKey=***************&deviceName=opmserver.mydomain.com
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. | String | - | Yes |
| deviceName | Name of the device to add | String | - | Yes |
| netmask | subnet mask of the device network | String | Allowed characters: 0–255 for each octet, dot(.) as separator | No |
| networkAddress | network address for discovery | String | Allowed characters: A–Z, a–z, all Unicode letters, 0–9, space( ), dot(.), exclamation(!), colon(:), at(@), hash(#), dollar($), greater than(>), equal(=), less than(<), ampersand(&), plus(+), asterisk(*), hyphen(-), backslash(\), slash(/), single quote('), comma(,), underscore(_), parenthesis(()) | No |
| credentialName | credential profile to use for discovery (SNMP, WMI, etc.) | String | - | No |
| addDeviceToNCM | adds the device to Network Configuration Manager | Boolean | - | No |
| addDeviceToIPAM | adds the device to IP Address Manager | Boolean | - | No |
| addType | Type of addition | String | Allowed values: addVMwareVC, addVMwareESX, addXen, addHyperv, addNutanix, addVxRail, addProxmox (case-insensitive) | No |
| addDeviceType | specifies device category | String | Allowed values: UCS | No |
| isOpUSPM | flag for OpUtils/Storage Performance Monitor integration | Boolean | - | No |
| displayName | Display Name of the device | String | - | No |
| type | device type | String | Allowed characters: A–Z, a–z, all Unicode letters, 0–9, space( ), comma(,), dot(.), hyphen(-), underscore(_), parenthesis(()), slash(/), plus(+), exclamation(!), at(@), hash(#), dollar($), square brackets([ ]), caret(^), colon(:), semicolon(;), equals(=), ampersand(&), single quote(') | No |
| isNonSNMP | indicates if SNMP discovery is used | Boolean | - | No |
| DEVICE_BEHAVIOUR | defines monitoring behavior or role of device | String | - | No |
| SERIES | device series line | String | - | No |
| MODEL | specific model name of the device | String | - | No |
| COLUMNNAME1 | optional custom attributes | String | - | No |
| COLUMNNAME2 | optional custom attributes | String | - | No |
| newgroupname | name of new device group to create | String | - | No |
| addGroupNameID | ID of existing group to add the device to | String | - | No |
| snmpPingSweepEnable | enables SNMP ping during discovery | Integer | - | No |
| sysDetails | includes system details in device data | Integer | - | No |
| arpDetails | includes ARP table details during addition | Integer | - | No |
| parentID | ID of parent device | Long | - | No |
| pollerID | Poller ID handling the device | Long | - | No |
| vxrailCredentialName | credential for VxRail device discovery | String | Allowed characters: A–Z, a–z, all Unicode letters, 0–9, hyphen(-), dot(.), underscore(_), plus(+), at(@), dollar($), space( ) | No |
| vxrailDeviceName | name of the VxRail device | String | - | No |
| availabilityNode | specifies the node used to track the device’s availability status | Boolean | - | No |
| autoVmDiscovery | enables automatic discovery of VMs on the device | Boolean | - | No |

## Sample Response

HTTP Code: 200

```json
{ "result":{ "deviceIp": "10.10.10.1", "message": "Device added successfully", "deviceName": "10.10.10.1", "moid": 3125}}
```

## Error Response

[View common error responses](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)

**Rate limit:** 10 requests per minute. Exceeding this limit will block requests for NO_TIME_LIMIT minute