Saltar al contenido principal
POST
/
clusters
Create a cluster
curl --request POST \
  --url https://api.ridergy.com/v1/clusters \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "North Campus",
  "locationIds": [
    "3632155",
    "3632156"
  ],
  "limitKw": 200
}
'
{
  "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"
}

Autorizaciones

x-api-key
string
header
requerido

Clave de API por tenant. El tenant se deriva de la clave — nunca de la solicitud.

Cuerpo

application/json
name
string
requerido
Ejemplo:

"North Campus"

locationIds
string[]
requerido
Minimum array length: 1
Ejemplo:
["3632155", "3632156"]
limitKw
number<float> | null

Límite de kW opcional para todo el clúster.

Ejemplo:

200

Respuesta

Clúster creado

clusterId
string
Ejemplo:

"clst_20260612_a1b2c3d4"

tenantUuid
string
name
string
Ejemplo:

"North Campus"

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

200

status
enum<string>
Opciones disponibles:
ACTIVE,
INACTIVE
createdAt
string<date-time>
updatedAt
string<date-time>