Saltar para o conteúdo principal
PATCH
/
clusters
/
{clusterId}
Update a cluster
curl --request PATCH \
  --url https://api.ridergy.com/v1/clusters/{clusterId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "limitKw": 250
}'
{
  "clusterId": "clst_20260612_a1b2c3d4",
  "tenantUuid": "<string>",
  "name": "North Campus",
  "locationIds": [
    "3632155",
    "3632156"
  ],
  "limitKw": 200,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Autorizações

​
x-api-key
string
header
obrigatório

Chave de API por tenant. O tenant é derivado da chave — nunca da requisição.

Parâmetros de caminho

​
clusterId
string
obrigatório

Corpo

application/json
​
name
string
Exemplo:

"North Campus"

​
limitKw
number | null

Defina como null para remover o limite máximo do cluster.

Exemplo:

250

​
locationIds
string[]
Minimum array length: 1
​
status
enum<string>
Opções disponíveis:
ACTIVE,
INACTIVE

Resposta

Cluster atualizado

​
clusterId
string
Exemplo:

"clst_20260612_a1b2c3d4"

​
tenantUuid
string
​
name
string
Exemplo:

"North Campus"

​
locationIds
string[]
Exemplo:
["3632155", "3632156"]
​
limitKw
number | null
Exemplo:

200

​
status
enum<string>
Opções disponíveis:
ACTIVE,
INACTIVE
​
createdAt
string<date-time>
​
updatedAt
string<date-time>