--- title: "Update a cluster" slug: "update-a-cluster" tags: ["Product Usage", "vIPS 10.1.10"] updated: 2026-09-11T20:35:31Z published: 2026-09-11T20:35:31Z canonical: "docs.trellix.com/update-a-cluster" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.trellix.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a cluster This URL updates a cluster based on the cluster id. ## Resource URL PUT /cluster/ ## Request Parameters URL Parameters: | Field Name | Description | Data Type | Mandatory | | --- | --- | --- | --- | | cluster id | Cluster ID. You can use the GET /cluster method to get the details of all the clusters. | string | Yes | Payload Parameters: | Field Name | Description | Data Type | Mandatory | | --- | --- | --- | --- | | description | A brief description of the cluster | string | Yes | | sharedSensorKey | Shared key to be used by the Sensors that will be registered with the cluster | string | Yes | ## Response Parameters Following fields are returned in the response. | Field Name | Description | Data Type | | --- | --- | --- | | success | Indicates if the PUT operation was successful. Value is set to true if the PUT operation is successful. Value is set to false if the PUT operation is not successful. | string | | msg | Message if the PUT operation is successful | string | | data | Not applicable | Not applicable | ## Example **Request** PUT [https://%3CNSM_IP%3E/intruvert/webservice/api/v1/cloud/cluster/3](https://%3CNSM_IP%3E/intruvert/webservice/api/v1/cloud/cluster/3) Payload ``` { "description": "test cluster ", "sharedSensorKey": "abc321" } ``` **Response** ``` { "success": true, "msg": "Successfully updated cluster [3]", "data": null } ```