This URL gets the ATD integration configuration in a particular Sensor.
Resource URL
GET sensor/<sensor_id>/atdintegration
Request Parameters
URL Parameter
| Field Name | Description | Data Type | Mandatory |
|---|---|---|---|
| sensor_id | Sensor id | Number | Yes |
Response Parameters
Following fields are returned if the request parameters are correct, otherwise error details are returned.
| Field Name | Description | Data Type |
|---|---|---|
| enableCommunication | Enable communication | Boolean |
| inheritSettings | Inherit settings | String |
| atdUsername | ATD user name | String |
| atdPassword | ATD password | String |
| sensorToATDCommunicationPort | Sensor to ATD communication port | Number |
| managerToATDCommunicationPort | Manager to ATD communication port | Number |
| atdApplianceIPAddr | ATD appliance IP address | String |
Example
Request
GET https://<NSM_IP>/sdkapi/sensor/0/atdintegration
Response
{
"enableCommunication":true,
“inheritSettings”:”false”,
"atdUsername":"admin",
"sensorToATDCommunicationPort":8505,
"managerToATDCommunicationPort":443,
"atdPassword":"admin123",
"atdApplianceIPAddr":"1.1.1.1"}
}
Error Information
Following error code is returned by this URL:
| No | HTTP Error Code | SDK API errorId | SDK API errorMessage |
|---|---|---|---|
| 1 | 400 | 1106 | Invalid Sensor id |