Passer au contenu principal
GET
/
clusters
/
{clusterId}
Get a cluster's live status
curl --request GET \
  --url https://api.ridergy.com/v1/clusters/{clusterId} \
  --header 'x-api-key: <api-key>'
{
  "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",
  "liveStatus": {
    "actualTotalKw": 130.8,
    "clusterLimitKw": 200,
    "sumLocationLimits": 200,
    "withinLimit": true,
    "locations": [
      {
        "locationId": "3632155",
        "setLimitKw": 100,
        "effectiveLimitKw": 80,
        "actualKw": 65.4
      }
    ]
  }
}

Autorisations

​
x-api-key
string
header
requis

Clé API par tenant. Le tenant est déterminé à partir de la clé — jamais à partir de la requête.

Paramètres de chemin

​
clusterId
string
requis

Réponse

Détail du cluster avec statut en direct

​
clusterId
string
Exemple:

"clst_20260612_a1b2c3d4"

​
tenantUuid
string
​
name
string
Exemple:

"North Campus"

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

200

​
status
enum<string>
Options disponibles:
ACTIVE,
INACTIVE
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
liveStatus
object