> ## Documentation Index > Fetch the complete documentation index at: https://docs.ridergy.com/llms.txt > Use this file to discover all available pages before exploring further. # Appliquer une programmation à tous les emplacements d'un cluster > Applique le même `LimitProfileRequest` à chaque site du cluster (équivalent à appeler `POST /locations/{locationId}/schedules` pour chaque membre). ## OpenAPI ````yaml /api-reference/energy-management/openapi.fr.yaml POST /clusters/{clusterId}/schedules openapi: 3.1.0 info: title: RiDERgy Energy Management API version: '1.0' license: name: Proprietary identifier: LicenseRef-Proprietary description: > Contrôle programmatique des limites de puissance de charge sur les sites, les bornes individuelles, les organisations et les clusters multi-sites. ## Authentification Tous les endpoints sauf `GET /health` nécessitent un en-tête `x-api-key`. Cette clé détermine votre tenant — elle n'est jamais lue depuis le corps de la requête ni depuis un autre en-tête, ainsi une clé d'un tenant ne peut pas accéder aux données d'un autre tenant. Votre tenant doit avoir la fonctionnalité Energy Management API activée, sinon les requêtes échouent avec `403 FEATURE_NOT_ENABLED`. Contactez RiDERgy pour l'activer. ## Modèle de priorité Les limites de site et de borne sont contrôlées via des **profils à fenêtres de priorité** : - Les priorités vont de **0 (la plus basse) à 10 (la plus haute)**, dans le style de la pile OCPP. - Une cible (site ou connecteur de borne) peut avoir jusqu'à 11 profils, un par niveau de priorité, chacun avec sa propre fenêtre `[startTime, endTime)`. - À tout moment, la **limite effective** est le `limitKw` du profil de priorité la plus élevée dont la fenêtre est actuellement active. - Si aucun profil n'est actif, un site revient à son `permanentLimitKw`. - Soumettre un profil à une priorité qui en possède déjà un pour cette cible le **remplace**. - Les profils sont appliqués et annulés automatiquement à leurs `startTime`/`endTime` — aucun appel d'API supplémentaire n'est nécessaire une fois le profil créé. Les enregistrements de profils ne sont jamais supprimés, l'historique reste donc consultable. ## Erreurs Toutes les erreurs partagent cette forme : ```json { "error": { "code": "LOCATION_NOT_FOUND", "message": "Location 123 was not found for the provided tenant", "requestId": "b1f6e6b0-..." } } ``` servers: - url: https://api.ridergy.com/v1 description: Production security: - ApiKeyAuth: [] tags: - name: Health description: Vérification de l'état du service, sans authentification. - name: Locations description: >- Lire et définir les limites de puissance et les profils de priorité au niveau du site. - name: Chargers description: >- Verrouiller des connecteurs de borne individuels sur une limite de puissance fixe pour une fenêtre temporelle. - name: Organizations description: >- Profils de plafond à l'échelle du tenant (enregistrés uniquement — l'application n'est pas encore active). - name: Clusters description: >- Regrouper des sites sous un plafond kW partagé et appliquer des plannings à l'ensemble du groupe. paths: /clusters/{clusterId}/schedules: post: tags: - Clusters summary: Apply a schedule to every location in a cluster description: | Applique le même `LimitProfileRequest` à chaque site du cluster (équivalent à appeler `POST /locations/{locationId}/schedules` pour chaque membre). operationId: applyClusterSchedule parameters: - $ref: '#/components/parameters/ClusterId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LimitProfileRequest' examples: example: value: startTime: '2026-06-12T08:00:00Z' endTime: '2026-06-12T18:00:00Z' limitKw: 50 priority: 5 responses: '200': description: Planning appliqué à au moins un site content: application/json: schema: $ref: '#/components/schemas/ClusterScheduleResponse' '400': description: Le cluster est inactif, vide, ou le corps de la requête est invalide content: application/json: schema: $ref: '#/components/schemas/Error' examples: clusterInactive: summary: CLUSTER_INACTIVE value: error: code: CLUSTER_INACTIVE message: Cluster clst_20260612_a1b2c3d4 is inactive requestId: b1f6e6b0-1234-4abc-9def-000000000000 clusterEmpty: summary: CLUSTER_EMPTY value: error: code: CLUSTER_EMPTY message: Cluster has no locations requestId: b1f6e6b0-1234-4abc-9def-000000000000 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/FeatureNotEnabled' '404': $ref: '#/components/responses/ClusterNotFound' components: parameters: ClusterId: name: clusterId in: path required: true schema: type: string example: clst_20260612_a1b2c3d4 schemas: LimitProfileRequest: type: object required: - startTime - endTime - limitKw properties: startTime: type: string format: date-time description: Horodatage UTC ISO-8601. Obligatoire. example: '2026-06-12T08:00:00Z' endTime: type: string format: date-time description: >- Horodatage UTC ISO-8601. Doit être postérieur à `startTime` et dans le futur. Obligatoire. example: '2026-06-12T18:00:00Z' limitKw: type: number format: float exclusiveMinimum: 0 description: Limite de puissance en kW. Doit être supérieure à 0. Obligatoire. example: 50 priority: type: integer minimum: 0 maximum: 10 default: 0 description: | Niveau de priorité dans le style de la pile OCPP, de 0 (la plus basse) à 10 (la plus haute). Soumettre un profil à une priorité qui existe déjà pour cette cible le remplace. example: 5 ClusterScheduleResponse: type: object properties: clusterId: type: string example: clst_20260612_a1b2c3d4 applied: type: array items: allOf: - type: object properties: locationId: type: string - $ref: '#/components/schemas/LocationScheduleResponse' errors: type: array items: type: object properties: locationId: type: string error: $ref: '#/components/schemas/Error' totalLocations: type: integer example: 2 Error: type: object properties: error: type: object properties: code: type: string example: LOCATION_NOT_FOUND message: type: string example: Location 123 was not found for the provided tenant requestId: type: string format: uuid LocationScheduleResponse: type: object properties: locationId: type: string example: '3632155' priority: type: integer example: 5 limitKw: type: number example: 50 startTime: type: string format: date-time endTime: type: string format: date-time status: $ref: '#/components/schemas/ProfileStatus' permanentLimitKw: type: - number - 'null' example: 100 effectiveLimitKw: type: - number - 'null' example: 50 ProfileStatus: type: string enum: - SCHEDULED - ACTIVE - EXPIRED responses: Unauthorized: description: Clé API manquante, invalide ou expirée content: application/json: schema: $ref: '#/components/schemas/Error' examples: unauthorized: value: error: code: UNAUTHORIZED message: Invalid or inactive API key requestId: b1f6e6b0-1234-4abc-9def-000000000000 FeatureNotEnabled: description: Le tenant n'a pas l'Energy Management API activée content: application/json: schema: $ref: '#/components/schemas/Error' examples: featureNotEnabled: value: error: code: FEATURE_NOT_ENABLED message: >- The Energy Management API is not enabled for your account. Contact RiDERgy to enable this feature. requestId: b1f6e6b0-1234-4abc-9def-000000000000 ClusterNotFound: description: Cluster introuvable content: application/json: schema: $ref: '#/components/schemas/Error' examples: clusterNotFound: value: error: code: CLUSTER_NOT_FOUND message: Cluster clst_20260612_a1b2c3d4 not found requestId: b1f6e6b0-1234-4abc-9def-000000000000 securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- Clé API par tenant. Le tenant est déterminé à partir de la clé — jamais à partir de la requête. ````