The new docs.trellix.com features a modernized UI and AI-powered conversational search. Content is currently available in English, with additional languages launching in early November 2026. We hope you enjoy the updated experience.

Update ATD Integration Configuration in Sensor

Prev Next

This URL updates the ATD integration configuration in a particular Sensor.

Resource URL

PUT sensor/<sensor_id>/atdintegration

Request Parameters

URL Parameters:

Field Name

Description

Data Type

Mandatory

sensor_id

Sensor id

Number

Yes

Payload Parameters:

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

Response Parameters

Following fields are returned if the request parameters are correct, otherwise error details are returned.

Field Name

Description

Data Type

status

Operation status

Number

Example

Request

PUT https://<NSM_IP>/sdkapi/sensor/0/atdintegration

          {
“inheritSettings”:”false”,
"enableCommunication":true,
"atdUsername":"admin",
"sensorToATDCommunicationPort":8505,
"managerToATDCommunicationPort":443,
"atdPassword":"admin123",
"atdApplianceIPAddr":"1.1.1.1"}

           }

Response

{
" status ": 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