Începe cu API-ul Instatus

Toate endpointurile se află sub URL-ul https://api.instatus.com. În general, respectă arhitectura REST.

Toate cererile trebuie codate ca JSON, cu headerul Content-Type: application/json.

Răspunsurile de la API-ul Instatus, inclusiv erorile, sunt codate tot ca JSON.

Autentificare

Cererile către API-ul Instatus trebuie să trimită o cheie API prin headerul Authorization:

Authorization: Bearer <API_KEY>

Creezi chei din panou › Dezvoltator, cu Creează cheie. Poți avea mai multe chei, fiecare cu numele ei, de exemplu „GitHub Actions” sau „Terraform”. Cheile încep cu inst_sk_.

Ce poate face o cheie

Fiecare cheie are setările ei:

  • Rol: Membru, Editor sau un rol personalizat în planul Business. Rolul decide ce poate vedea și modifica cheia, la fel ca în cazul oamenilor. O cheie nu poate fi Proprietar, așa că facturarea, rolurile și ștergerea rămân la oameni.
  • Acces: Vizualizare și modificare sau Doar vizualizare. O cheie cu Doar vizualizare nu poate modifica nimic, orice i-ar permite rolul.
  • Proiecte: toate proiectele, inclusiv cele pe care le adaugi mai târziu, sau doar cele pe care le alegi.
  • Expirare: data la care cheia nu mai funcționează. În planul Free, o cheie poate dura cel mult 90 de zile, în Pro cel mult 1 an, iar în Business și Enterprise oricât vrei, inclusiv fără expirare. Un proprietar al echipei poate stabili o limită mai scurtă în Setările echipei › Chei API. Cheile create înainte de setările pentru chei nu sunt afectate, iar cheile existente își păstrează data când se schimbă planul tău.
  • IP-uri permise: în planul Business, cheia funcționează doar de la adresele sau intervalele IP pe care le enumeri.

O cheie aparține echipei sau ție:

  • Cheile de echipă funcționează în continuare când persoana care le-a creat pleacă din echipă. Folosește-le pentru CI, scripturi și integrări.
  • Cheile personale acționează ca tine și nu fac niciodată mai mult decât poți tu. Pot folosi rolul La fel ca tine și nu mai funcționează dacă pleci din echipă.

Proprietarii echipei stabilesc regulile pentru chei în Setările echipei › Chei API: cât poate dura cel mult o cheie, dacă membrii pot crea chei ale echipei și dacă sunt permise cheile personale.

Crearea, modificarea, rotirea și revocarea unei chei apar în Activitatea echipei, la fel și o cheie revocată pentru că a fost expusă public. Tot ce se face printr-o cheie sau printr-o aplicație conectată apare acolo ca persoană prin numele cheii sau al aplicației.

Păstrează cheile în siguranță

  • O cheie este afișată o singură dată, când o creezi. Copiaz-o atunci și păstreaz-o ca pe un secret.
  • Ca să înlocuiești o cheie, deschide-o și dă clic pe Rotește. Alege cât timp mai funcționează cheia veche, până la 7 zile, ca să ai timp să actualizezi tot ce o folosește.
  • Revocă o cheie din meniul ei și nu mai funcționează imediat.

Cheile create înainte de setările pentru chei funcționează în continuare, neschimbate. Apar ca „Creată înainte de setările cheilor” în Dezvoltator, unde le poți adăuga limite sau le poți înlocui cu o cheie nouă.

Erori ale cheilor

Când o cheie nu poate face o cerere, eroarea are unul dintre aceste coduri, iar mesajul ei spune ce trebuie schimbat.

CodStatusDe ce
invalid_key401Cheia nu există. Verifică dacă ai copiat-o în întregime.
key_expired401Cheia a trecut de data de expirare.
key_revoked401Cheia a fost revocată.
key_owner_left401Persoana ca care acționează o cheie personală a plecat din echipă.
key_view_only403Cheia are Doar vizualizare, iar cererea modifică ceva.
role_not_allowed403Rolul cheii nu poate vedea sau modifica asta.
ip_not_allowed403Cererea a venit de la o adresă IP pe care cheia nu o permite.
page_not_allowed403Cheia nu poate folosi acest proiect.
account_action_not_allowed403Cheile nu pot crea sau elimina pagini, echipe ori spații de lucru. Folosește panoul.
route_not_allowed403Ruta nu face parte din API-ul documentat.

Obține ID-ul paginii tale

ID-ul paginii tale poate fi găsit în panou, urmând acești pași:

  1. Mergi la panoul tău.
  2. Dă clic dreapta pe proiectul tău din colțul din stânga sus, ca să deschizi meniul.
  3. Dă clic pe Copy Project ID și ID-ul paginii tale se copiază în clipboard.
ID pagină

Erori

Toate endpointurile API includ un cod și un mesaj în răspunsurile de eroare.

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

Valorile stărilor

Stări posibile ale paginii. Aceasta este starea detaliată (status) întoarsă de API-ul actual (v2 și ulterior). Endpointul vechi summary.json și notificările prin webhook folosesc o formă condensată, doar cu UP, HASISSUES și UNDERMAINTENANCE.

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

Stări posibile ale componentelor:

  • OPERATIONAL
  • UNDERMAINTENANCE
  • DEGRADEDPERFORMANCE
  • PARTIALOUTAGE
  • MAJOROUTAGE

Stări posibile ale incidentelor:

  • INVESTIGATING
  • IDENTIFIED
  • MONITORING
  • RESOLVED

Stări posibile ale mentenanțelor:

  • NOTSTARTEDYET
  • INPROGRESS
  • COMPLETED

Sari la endpointuri: