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 Cluster ID Based on Name

Prev Next

This URL retrieves the Trellix Virtual IPS cluster id based on name.

Resource URL

POST /cloud/getclusterid

Request Parameters

URL Parameters

None

Payload Request Parameters

Field Name

Description

Data Type

Mandatory

name

Cluster name

String

Yes

Response Parameters

Following fields are returned:

Field Name

Description

Data Type

createdResourceId

The cluster id

Number

Example

Request

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

Payload

{
	‘name’ : ‘clusterName’
}

Response

{
	‘createdResourceId’ : 101
}

Error Information

None