Démarrer avec l’API Instatus

Tous les points de terminaison se trouvent sous l’URL https://api.instatus.com. Ils suivent généralement l’architecture REST.

Toutes les requêtes doivent être encodées en JSON avec l’en-tête Content-Type: application/json.

Les réponses de l’API Instatus, y compris les erreurs, sont également encodées en JSON.

Authentification

Les requêtes vers l’API Instatus doivent envoyer une clé d’API via l’en-tête Authorization :

Authorization: Bearer <API_KEY>

Créez vos clés dans Tableau de bord › Développeur avec Créer une clé. Vous pouvez avoir plusieurs clés, chacune avec son propre nom, comme « GitHub Actions » ou « Terraform ». Les clés commencent par inst_sk_.

Ce qu’une clé peut faire

Chaque clé a ses propres réglages :

  • Rôle : Membre, Éditeur, ou un rôle personnalisé avec l’offre Business. Le rôle décide de ce que la clé peut consulter et modifier, comme pour les personnes. Une clé ne peut pas être Propriétaire : la facturation, les rôles et les suppressions restent entre les mains des personnes.
  • Accès : Voir et modifier, ou Voir seulement. Une clé en « Voir seulement » ne peut rien modifier, quoi que son rôle autorise.
  • Projets : tous les projets, y compris ceux que vous ajouterez plus tard, ou seulement ceux que vous choisissez.
  • Expiration : la date à laquelle la clé cesse de fonctionner. Avec l’offre Free, une clé peut durer jusqu’à 90 jours, avec Pro jusqu’à 1 an, et avec Business et Enterprise aussi longtemps que vous voulez, voire sans expiration. Un propriétaire de l’équipe peut fixer une limite plus courte dans Paramètres de l’équipe › Clés d’API. Les clés créées avant les réglages de clé ne sont pas concernées, et les clés existantes gardent leur date quand votre offre change.
  • IP autorisées : avec l’offre Business, la clé ne fonctionne que depuis les adresses ou plages IP que vous indiquez.

Une clé appartient à l’équipe ou à vous :

  • Les clés d’équipe continuent de fonctionner quand la personne qui les a créées quitte l’équipe. Utilisez-les pour la CI, les scripts et les intégrations.
  • Les clés personnelles agissent en votre nom et ne font jamais plus que vous. Elles peuvent avoir Le même que vous comme rôle, et cessent de fonctionner si vous quittez l’équipe.

Les propriétaires de l’équipe fixent les règles des clés dans Paramètres de l’équipe › Clés d’API : la durée maximale d’une clé, si les membres peuvent créer des clés d’équipe, et si les clés personnelles sont autorisées.

La création, la modification, le renouvellement et la révocation d’une clé apparaissent dans l’Activité de l’équipe, tout comme une clé révoquée parce qu’elle a fuité. Tout ce qui est fait avec une clé ou une app connectée y apparaît sous la forme personne via nom de la clé ou de l’app.

Protéger vos clés

  • Une clé n’est affichée qu’une seule fois, à sa création. Copiez-la à ce moment-là et conservez-la comme un secret.
  • Pour remplacer une clé, ouvrez-la et cliquez sur Renouveler. Choisissez combien de temps l’ancienne clé continue de fonctionner, jusqu’à 7 jours, pour avoir le temps de mettre à jour tout ce qui l’utilise.
  • Révoquez une clé depuis son menu : elle cesse de fonctionner immédiatement.

Les clés créées avant les réglages de clé continuent de fonctionner sans changement. Elles apparaissent comme « Créée avant les réglages des clés » dans Développeur, où vous pouvez leur ajouter des limites ou les remplacer par une nouvelle clé.

Erreurs de clé

Quand une clé ne peut pas effectuer une requête, l’erreur porte l’un de ces codes, et son message indique ce qu’il faut changer.

CodeStatutRaison
invalid_key401La clé n’existe pas. Vérifiez que vous l’avez copiée en entier.
key_expired401La clé a dépassé sa date d’expiration.
key_revoked401La clé a été révoquée.
key_owner_left401La personne au nom de laquelle agit une clé personnelle a quitté l’équipe.
key_view_only403La clé est en « Voir seulement » et la requête modifie quelque chose.
role_not_allowed403Le rôle de la clé ne permet pas de consulter ou de modifier cet élément.
ip_not_allowed403La requête provient d’une adresse IP que la clé n’autorise pas.
page_not_allowed403La clé ne peut pas utiliser ce projet.
account_action_not_allowed403Les clés ne peuvent pas créer ni supprimer de pages, d’équipes ou d’espaces de travail. Utilisez le tableau de bord.
route_not_allowed403La route ne fait pas partie de l’API documentée.

Récupérer votre ID de page

Votre ID de page se trouve dans le tableau de bord en suivant ces étapes :

  1. Allez dans votre tableau de bord.
  2. Faites un clic droit sur votre projet en haut à gauche pour ouvrir le menu.
  3. Cliquez sur Copy Project ID : votre ID de page est copié dans le presse-papiers.
ID de la page

Erreurs

Tous les points de terminaison de l’API renvoient un code et un message dans leurs réponses d’erreur.

{
"error": {
"code": "forbidden",
"message": "Not authorized"
}
}

Valeurs de statut

Statuts de page possibles. Il s’agit du status détaillé renvoyé par l’API actuelle (v2 et ultérieure). L’ancien point de terminaison summary.json et les notifications par webhook utilisent une forme condensée avec seulement UP, HASISSUES et UNDERMAINTENANCE.

  • UP
  • HASISSUES
  • ALLUNDERMAINTENANCE
  • ALLDEGRADEDPERFORMANCE
  • ALLPARTIALOUTAGE
  • ALLMINOROUTAGE
  • ALLMAJOROUTAGE
  • SOMEUNDERMAINTENANCE
  • SOMEDEGRADEDPERFORMANCE
  • SOMEPARTIALOUTAGE
  • SOMEMINOROUTAGE
  • SOMEMAJOROUTAGE
  • ONEUNDERMAINTENANCE
  • ONEDEGRADEDPERFORMANCE
  • ONEPARTIALOUTAGE
  • ONEMINOROUTAGE
  • ONEMAJOROUTAGE

Statuts de composant possibles :

  • OPERATIONAL
  • UNDERMAINTENANCE
  • DEGRADEDPERFORMANCE
  • PARTIALOUTAGE
  • MAJOROUTAGE

Statuts d’incident possibles :

  • INVESTIGATING
  • IDENTIFIED
  • MONITORING
  • RESOLVED

Statuts de maintenance possibles :

  • NOTSTARTEDYET
  • INPROGRESS
  • COMPLETED

Accéder aux points de terminaison :