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 fournir un jeton d’API via l’en-tête Authorization :

Vous pouvez récupérer votre clé d’API dans Paramètres du compte → Paramètres développeur

Authorization: Bearer <API_KEY>

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.

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 :