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.

Allocate NMS IP to Sensor

Prev Next

This URL allocates the NMS IP to Sensor.

Resource URL

POST /sensor/<sensor_id> /nmsip/allocate/<ipId>

Request Parameters

URL Parameters:

Field Name

Description

Data Type

Mandatory

sensorId

Sensor id

Number

Yes

IPId

NMS IP id

Number

Yes

Payload Parameters:

None

Response Parameters

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

Field Name

Description

Data Type

createdResourceId

Unique id of the created domain

Number

Example

Request

POST https://<NSM_IP>/sdkapi/sensor/1001/nmsip/allocate/49

Payload

None

Response

{
       "createdResourceId": 50
}

Error Information

Following error codes are returned by this URL:

No

HTTP Error Code

SDK API errorId

SDK API errorMessage

1

404

1106

Invalid Sensor

2

400

1124

The Sensor is inactive

3

400

5401

FIPS enabled on Sensor

4

400

5601

IP address cannot be empty

5

400

5602

Same IP already exists in Sensor

6

400

5603

Same IP already exists in domain

7

400

5604

Maximum IP addresses allowed exceeded

8

400

5605

Maximum IPv6 addresses allowed exceeded

9

400

5606

Maximum IPv4 addresses allowed exceeded

10

400

5607

IP address not present in this domain

11

400

1406

Invalid IP format

12

400

5608

Invalid IP id given for allocation: ID