API

Maintenance

Référence de l'API pour Maintenance : chaque handler avec ses champs et un exemple.

Dernière mise à jour :

maintenance: detail

Récupérer une maintenance

Renvoie une maintenance par son identifiant, avec statut, horaires prévus et réels et texte d’annonce.

  • Scope requis: maintenance:read
  • Endpoint: POST /api/query
Champ Type Obligatoire Description
id string (uuid) oui

Exemple de requête

curl -X POST https://status.example.com/api/query \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "publicstatus:query:maintenance:detail",
  "payload": {
    "id": "00000000-0000-4000-8000-000000000001"
  }
}'

maintenance: list

Lister les maintenances

Renvoie une liste filtrée et paginée de maintenances, y compris les passées et annulées, avec statut et créneau prévu.

  • Scope requis: maintenance:read
  • Endpoint: POST /api/query
Champ Type Obligatoire Description
cursor string non Position issue de nextCursor de la page précédente.
limit integer non Lignes par page, 50 par défaut, au maximum 200.
search string non Recherche plein texte dans les champs interrogeables.
sort string non Champ servant au tri.
sortDirection “asc” | “desc” non asc ou desc.
offset integer non Nombre de lignes à ignorer. Pour paginer, préfère cursor.
totalCount boolean non Avec true, tu reçois aussi total, le nombre de lignes correspondantes.
includeDeleted boolean non Avec true, les lignes supprimées sont incluses. Uniquement pour les entités avec suppression logique.
onlyDeleted boolean non Avec true, seules les lignes supprimées sont renvoyées. Uniquement pour les entités avec suppression logique, pas avec includeDeleted.
filter object non Un filtre de champ avec field, op et value. op est l’un de eq, ne, lt, gt, lte, gte, in.
filter.field string oui
filter.op “eq” | “ne” | “lt” | “gt” | “lte” | “gte” | “in” oui
filter.value any oui
filters array of object non Plusieurs filtres de champ, chacun avec field, op et value. op est l’un de eq, ne, lt, gt, lte, gte, in.
namedFilter string non Nom d’un filtre prédéfini de l’entité, par exemple une file de travail.
aggregate object non Renvoie des valeurs agrégées au lieu de lignes.
aggregate.groupBy string non
aggregate.measures array of object non

Exemple de requête

curl -X POST https://status.example.com/api/query \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "publicstatus:query:maintenance:list",
  "payload": {}
}'

Exemple de réponse

Statut : 200

{
  "data": {
    "rows": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "tenantId": "00000000-0000-4000-8000-000000000002",
        "version": 2,
        "insertedAt": "2026-01-15T09:30:00.000Z",
        "modifiedAt": null,
        "insertedById": "00000000-0000-4000-8000-000000000003",
        "modifiedById": null,
        "title": "Database upgrade",
        "body": "Short read-only period while we upgrade the database.",
        "status": "scheduled",
        "scheduledStart": "2026-01-15T09:30:00.000Z",
        "scheduledEnd": "2026-01-15T09:30:00.000Z",
        "startedAt": null,
        "completedAt": null,
        "cancelledAt": null
      }
    ],
    "nextCursor": null
  }
}

maintenance: cancel

Annuler une maintenance

Annule une maintenance planifiée ou en cours et enregistre l’heure de l’annulation.

  • Scope requis: maintenance:write
  • Endpoint: POST /api/write
Champ Type Obligatoire Description
id string (uuid) oui
version number non

Exemple de requête

curl -X POST https://status.example.com/api/write \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "publicstatus:write:maintenance:cancel",
  "payload": {
    "id": "00000000-0000-4000-8000-000000000001",
    "version": 1
  }
}'

maintenance: complete

Terminer une maintenance

Passe une maintenance en cours à terminée et enregistre son heure de fin réelle.

  • Scope requis: maintenance:write
  • Endpoint: POST /api/write
Champ Type Obligatoire Description
id string (uuid) oui
version number non

Exemple de requête

curl -X POST https://status.example.com/api/write \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "publicstatus:write:maintenance:complete",
  "payload": {
    "id": "00000000-0000-4000-8000-000000000001",
    "version": 1
  }
}'

maintenance: schedule

Planifier une maintenance

Planifie une nouvelle fenêtre de maintenance avec titre, description et période et, au besoin, la lie aux composants concernés.

  • Scope requis: maintenance:write
  • Endpoint: POST /api/write
Champ Type Obligatoire Description
title string oui Titre
body string oui Description
scheduledStart string (date-time) oui Début prévu
scheduledEnd string (date-time) oui Fin prévue
componentIds array of string (uuid) non Composants concernés

Exemple de requête

curl -X POST https://status.example.com/api/write \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "publicstatus:write:maintenance:schedule",
  "payload": {
    "title": "Database upgrade",
    "body": "Short read-only period while we upgrade the database.",
    "scheduledStart": "2026-01-15T09:30:00.000Z",
    "scheduledEnd": "2026-01-15T09:30:00.000Z",
    "componentIds": [
      "00000000-0000-4000-8000-000000000001"
    ]
  }
}'

Exemple de réponse

Statut : 200

{
  "isSuccess": true,
  "data": {
    "id": "00000000-0000-4000-8000-000000000002"
  }
}

maintenance: start

Démarrer une maintenance

Passe une maintenance planifiée à en cours et enregistre son heure de début réelle.

  • Scope requis: maintenance:write
  • Endpoint: POST /api/write
Champ Type Obligatoire Description
id string (uuid) oui
version number non

Exemple de requête

curl -X POST https://status.example.com/api/write \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "publicstatus:write:maintenance:start",
  "payload": {
    "id": "00000000-0000-4000-8000-000000000001",
    "version": 1
  }
}'