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.

Get the Controller ID Based on Name

Prev Next

This URL retrieves the Trellix vIPS controller ID based on name.

Resource URL

POST /cloud/getcontrollerid

Request Parameters

URL Parameters

None

Payload Request Parameters

Field Name Description Data Type Mandatory
name Controller name String Yes

Response Parameters

Following fields are returned:

Field Name Description Data Type
createdResourceId The controller id Number

Example

Request

POST https://<NSM_IP>/sdkapi/cloud/getcontrollerid

Payload

{
	‘name’ : ‘controllerName’
} 

Response

{
	‘createdResourceId’ : 101
} 
 

Error Information

None