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 the vIPS Cluster Agent

Prev Next

This URL updates the vIPS cluster agents.

Resource URL

PUT /cloud/cluster/<id>/upgradeagents

Request Parameters

URL Parameters

Field Name Description Data Type Mandatory
id Cluster id Number Yes

Payload Request Parameters

None

Response Parameters

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

Field Name Description Data Type
status Set to 1 if the update was successful Number

Example

Request

PUT https://<NSM_IP>/sdkapi/cloud/cluster/101/upgradeagents

Payload

None

Response

{
"status": 1
} 
 

Error Information

Following error codes are returned by this URL:

No HTTP Error Code SDK API errorId SDK API errorMessage
1 500 1001 Internal error message: internal server error
2 400 11001 Get failed for id <id> : <error>