API

Components

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

Dernière mise à jour :

component: detail

Récupérer un composant

Renvoie un composant par son identifiant, avec statut, composant parent, ordre et champs personnalisés.

  • Scope requis: components: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:component:detail",
  "payload": {
    "id": "00000000-0000-4000-8000-000000000001"
  }
}'

component: list

Lister les composants

Renvoie une liste filtrée et paginée de composants, y compris les masqués, avec leur statut et leur regroupement.

  • Scope requis: components: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:component:list",
  "payload": {}
}'

Exemple de réponse

Statut : 200

{
  "data": {
    "rows": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "tenantId": "00000000-0000-4000-8000-000000000002",
        "version": 1,
        "insertedAt": "2026-01-15T09:30:00.000Z",
        "modifiedAt": null,
        "insertedById": "00000000-0000-4000-8000-000000000003",
        "modifiedById": null,
        "name": "API",
        "description": null,
        "status": "operational",
        "parentComponentId": null,
        "displayOrder": 0,
        "showOnPage": true,
        "customFields": {}
      }
    ],
    "nextCursor": null
  }
}

component: create

Créer un composant

Crée un nouveau composant de la page de statut, affiché avec son propre statut opérationnel.

  • Scope requis: components:write
  • Endpoint: POST /api/write
Champ Type Obligatoire Description
name string oui Nom
description string non Description
status “operational” | “degraded-performance” | “partial-outage” | “major-outage” | “under-maintenance” non Statut
parentComponentId string non Composant parent
displayOrder integer non Ordre d’affichage
showOnPage boolean non Public
customFields object 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:component:create",
  "payload": {
    "name": "API"
  }
}'

Exemple de réponse

Statut : 200

{
  "isSuccess": true,
  "data": {
    "kind": "save",
    "id": "00000000-0000-4000-8000-000000000001",
    "data": {
      "id": "00000000-0000-4000-8000-000000000001",
      "tenantId": "00000000-0000-4000-8000-000000000002",
      "version": 1,
      "insertedAt": "2026-01-15T09:30:00.000Z",
      "modifiedAt": null,
      "insertedById": "00000000-0000-4000-8000-000000000003",
      "modifiedById": null,
      "name": "API",
      "description": null,
      "status": "operational",
      "parentComponentId": null,
      "displayOrder": 0,
      "showOnPage": true,
      "customFields": {}
    },
    "changes": {
      "name": "API",
      "status": "operational",
      "displayOrder": 0,
      "showOnPage": true
    },
    "previous": {},
    "isNew": true,
    "entityName": "component"
  }
}

component: delete

Supprimer un composant

Supprime définitivement un composant. Les liens d’anciens incidents et maintenances pointent alors vers un composant qui n’existe plus.

  • Scope requis: components:write
  • Endpoint: POST /api/write
Champ Type Obligatoire Description
id string (uuid) oui

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:component:delete",
  "payload": {
    "id": "00000000-0000-4000-8000-000000000001"
  }
}'

component: update

Modifier un composant

Modifie les champs d’un composant, y compris le statut opérationnel que voient les visiteurs.

  • Scope requis: components:write
  • Endpoint: POST /api/write
Champ Type Obligatoire Description
id string (uuid) oui
version number oui
changes object oui
changes.name string non Nom
changes.description string | null non Description
changes.status “operational” | “degraded-performance” | “partial-outage” | “major-outage” | “under-maintenance” non Statut
changes.parentComponentId string | null non Composant parent
changes.displayOrder integer non Ordre d’affichage
changes.showOnPage boolean non Public
changes.customFields object 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:component:update",
  "payload": {
    "id": "00000000-0000-4000-8000-000000000001",
    "version": 1,
    "changes": {
      "name": "text",
      "description": "text",
      "status": "operational",
      "parentComponentId": "text",
      "displayOrder": 1,
      "showOnPage": true,
      "customFields": {}
    }
  }
}'