Kom igång med Instatus API

Alla endpoints finns under URL:en https://api.instatus.com. De följer i stort sett REST-arkitekturen.

Alla anrop måste vara kodade som JSON med headern Content-Type: application/json.

Svaren från Instatus API, inklusive fel, är också kodade som JSON.

Autentisering

Anrop till Instatus API måste skicka med en API-nyckel via Authorization-headern:

Authorization: Bearer <API_KEY>

Skapa nycklar i dashboarden › Utvecklare med Skapa nyckel. Du kan ha flera nycklar, var och en med sitt eget namn, till exempel ”GitHub Actions” eller ”Terraform”. Nycklarna börjar med inst_sk_.

Vad en nyckel kan göra

Varje nyckel har sina egna inställningar:

  • Roll: Medlem, Redaktör eller en anpassad roll i Business-planen. Rollen avgör vad nyckeln kan se och ändra, precis som för personer. En nyckel kan inte vara Ägare, så fakturering, roller och borttagning stannar hos personer.
  • Åtkomst: Visa och ändra eller Bara visa. En nyckel med Bara visa kan inte ändra något, oavsett vad rollen tillåter.
  • Projekt: alla projekt, även de du lägger till senare, eller bara de du väljer.
  • Utgång: datumet då nyckeln slutar fungera. I Free-planen kan en nyckel gälla i upp till 90 dagar, i Pro i upp till 1 år och i Business och Enterprise hur länge du vill, även utan utgång. En teamägare kan sätta en kortare gräns i Teaminställningar › API-nycklar. Nycklar som skapades före nyckelinställningarna påverkas inte, och befintliga nycklar behåller sitt datum när din plan ändras.
  • Tillåtna IP-adresser: i Business-planen fungerar nyckeln bara från de IP-adresser eller intervall du anger.

En nyckel tillhör teamet eller dig:

  • Teamnycklar fortsätter fungera när personen som skapade dem lämnar teamet. Använd dem för CI, skript och integrationer.
  • Personliga nycklar agerar som du och kan aldrig göra mer än du. De kan använda Samma som du som roll och slutar fungera om du lämnar teamet.

Teamets ägare sätter reglerna för nycklar i Teaminställningar › API-nycklar: hur länge en nyckel som längst får gälla, om medlemmar får skapa teamnycklar och om personliga nycklar är tillåtna.

När en nyckel skapas, ändras, roteras eller återkallas syns det i teamets Aktivitet, och det gör även en nyckel som återkallades för att den hade läckt. Allt som görs via en nyckel eller en ansluten app visas där som person via nyckelns eller appens namn.

Håll nycklarna säkra

  • En nyckel visas bara en gång, när du skapar den. Kopiera den då och förvara den som en hemlighet.
  • Om du vill byta ut en nyckel öppnar du den och klickar på Rotera. Välj hur länge den gamla nyckeln ska fortsätta fungera, upp till 7 dagar, så att du hinner uppdatera allt som använder den.
  • Återkalla en nyckel från dess meny så slutar den fungera direkt.

Nycklar som skapades före nyckelinställningarna fortsätter fungera som tidigare. De visas som ”Skapad före nyckelinställningar” under Utvecklare, där du kan lägga till begränsningar eller ersätta dem med en ny nyckel.

Nyckelfel

När en nyckel inte får göra ett anrop har felet en av de här koderna, och meddelandet säger vad du behöver ändra.

KodStatusVarför
invalid_key401Nyckeln finns inte. Kontrollera att du kopierade hela.
key_expired401Nyckeln har passerat sitt utgångsdatum.
key_revoked401Nyckeln har återkallats.
key_owner_left401Personen som en personlig nyckel agerar som har lämnat teamet.
key_view_only403Nyckeln har Bara visa och anropet ändrar något.
role_not_allowed403Nyckelns roll får inte se eller ändra det här.
ip_not_allowed403Anropet kom från en IP-adress som nyckeln inte tillåter.
page_not_allowed403Nyckeln får inte använda det här projektet.
account_action_not_allowed403Nycklar kan inte skapa eller ta bort sidor, team eller arbetsytor. Använd dashboarden.
route_not_allowed403Routen ingår inte i det dokumenterade API:et.

Hämta ditt sid-ID

Du hittar ditt sid-ID i dashboarden så här:

  1. Gå till din dashboard.
  2. Högerklicka på ditt projekt uppe till vänster för att öppna menyn.
  3. Klicka på Kopiera projekt-ID så kopieras ditt sid-ID till urklipp.
Sid-ID

Fel

Alla API-endpoints innehåller en kod och ett meddelande i felsvaren.

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

Statusvärden

Möjliga sidstatusar. Det här är den detaljerade status som returneras av det nuvarande API:et (v2 och senare). Den äldre endpointen summary.json och webhook-aviseringar använder en förenklad form med bara UP, HASISSUES och UNDERMAINTENANCE.

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

Möjliga komponentstatusar:

  • OPERATIONAL
  • UNDERMAINTENANCE
  • DEGRADEDPERFORMANCE
  • PARTIALOUTAGE
  • MAJOROUTAGE

Möjliga incidentstatusar:

  • INVESTIGATING
  • IDENTIFIED
  • MONITORING
  • RESOLVED

Möjliga underhållsstatusar:

  • NOTSTARTEDYET
  • INPROGRESS
  • COMPLETED

Hoppa till endpoints: