Update a cluster

This URL updates a cluster based on the cluster id.

PUT /cluster/<cluster id>

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

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
`trafficSource`	Source of traffic (GWLB or Probe)	string	Yes

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

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

Request

Payload

{
			"description": "test cluster ",
			"sharedSensorKey": "abc321",
			"trafficSource":"GWLB",
}

Response

{
"success": true,
"msg": "Successfully updated cluster [3]",
"data": null
}