Kom godt i gang med Instatus API

Alle endpoints ligger under URL'en https://api.instatus.com. De følger overordnet set REST-arkitekturen.

Alle forespørgsler skal være kodet som JSON med headeren Content-Type: application/json.

Svar fra Instatus API, inklusive fejl, er ligeledes kodet som JSON.

Godkendelse

Forespørgsler til Instatus API skal sende en API-nøgle i Authorization-headeren:

Authorization: Bearer <API_KEY>

Opret nøgler under Dashboard › Udvikler med Opret nøgle. Du kan have flere nøgler, hver med sit eget navn, f.eks. "GitHub Actions" eller "Terraform". Nøgler starter med inst_sk_.

Hvad en nøgle kan

Hver nøgle har sine egne indstillinger:

  • Rolle: Medlem, Redaktør eller en brugerdefineret rolle på Business-planen. Rollen bestemmer, hvad nøglen kan se og ændre, på samme måde som for personer. En nøgle kan ikke være Ejer, så fakturering, roller og sletning forbliver hos personer.
  • Adgang: Se og ændre eller Kun se. En nøgle med Kun se kan ikke ændre noget, uanset hvad dens rolle tillader.
  • Projekter: alle projekter, også dem du tilføjer senere, eller kun dem du vælger.
  • Udløb: den dato, hvor nøglen holder op med at virke. På Free-planen kan en nøgle højst gælde i 90 dage, på Pro i op til 1 år og på Business og Enterprise så længe du vil, også uden udløb. En teamejer kan sætte en kortere grænse under Teamindstillinger › API-nøgler. Nøgler, der blev lavet før nøgleindstillingerne, berøres ikke, og eksisterende nøgler beholder deres dato, når din plan skifter.
  • Tilladte IP-adresser: på Business-planen virker nøglen kun fra de IP-adresser eller -intervaller, du angiver.

En nøgle tilhører teamet eller dig:

  • Teamnøgler bliver ved med at virke, når den person, der lavede dem, forlader teamet. Brug dem til CI, scripts og integrationer.
  • Personlige nøgler handler som dig og kan aldrig mere end dig. De kan bruge Samme som dig som rolle og holder op med at virke, hvis du forlader teamet.

Teamejere fastsætter reglerne for nøgler under Teamindstillinger › API-nøgler: hvor længe en nøgle højst kan gælde, om medlemmer må lave teamnøgler, og om personlige nøgler er tilladt.

Når en nøgle oprettes, ændres, roteres eller tilbagekaldes, vises det i teamets Aktivitet, og det samme gør en nøgle, der blev tilbagekaldt, fordi den var lækket. Alt, der gøres via en nøgle eller en tilsluttet app, vises der som person via nøglens eller appens navn.

Pas godt på nøglerne

  • En nøgle vises kun én gang, når du opretter den. Kopiér den med det samme, og gem den som en hemmelighed.
  • For at udskifte en nøgle skal du åbne den og klikke på Rotér. Vælg, hvor længe den gamle nøgle bliver ved med at virke, op til 7 dage, så du har tid til at opdatere alt, der bruger den.
  • Tilbagekald en nøgle fra dens menu, så holder den op med at virke med det samme.

Nøgler, der blev lavet før nøgleindstillingerne, virker uændret. De vises som "Oprettet før nøgleindstillinger" under Udvikler, hvor du kan tilføje begrænsninger eller udskifte dem med en ny nøgle.

Nøglefejl

Når en nøgle ikke må udføre en forespørgsel, har fejlen en af disse koder, og beskeden fortæller, hvad du skal ændre.

KodeStatusÅrsag
invalid_key401Nøglen findes ikke. Tjek, at du har kopieret hele nøglen.
key_expired401Nøglen har passeret sin udløbsdato.
key_revoked401Nøglen blev tilbagekaldt.
key_owner_left401Den person, en personlig nøgle handler som, har forladt teamet.
key_view_only403Nøglen er sat til Kun se, og forespørgslen ændrer noget.
role_not_allowed403Nøglens rolle må ikke se eller ændre dette.
ip_not_allowed403Forespørgslen kom fra en IP-adresse, som nøglen ikke tillader.
page_not_allowed403Nøglen må ikke bruge dette projekt.
account_action_not_allowed403Nøgler kan ikke oprette eller fjerne sider, teams eller workspaces. Brug dashboardet.
route_not_allowed403Ruten er ikke en del af den dokumenterede API.

Find dit side-ID

Du finder dit side-ID i dashboardet på denne måde:

  1. Gå til dit dashboard.
  2. Højreklik på dit projekt i øverste venstre hjørne for at åbne menuen.
  3. Klik på Kopiér projekt-ID, så bliver dit side-ID kopieret til udklipsholderen.
Side-ID

Fejl

Alle API-endpoints returnerer en kode og en besked i fejlsvarene.

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

Statusværdier

Mulige sidestatusser. Det er den detaljerede status, som det nuværende API (v2 og senere) returnerer. Det ældre summary.json-endpoint og webhook-notifikationer bruger en forenklet form med kun UP, HASISSUES og UNDERMAINTENANCE.

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

Mulige komponentstatusser:

  • OPERATIONAL
  • UNDERMAINTENANCE
  • DEGRADEDPERFORMANCE
  • PARTIALOUTAGE
  • MAJOROUTAGE

Mulige hændelsesstatusser:

  • INVESTIGATING
  • IDENTIFIED
  • MONITORING
  • RESOLVED

Mulige vedligeholdelsesstatusser:

  • NOTSTARTEDYET
  • INPROGRESS
  • COMPLETED

Spring til endpoints: