Kom i gang med Instatus API

Alle endepunkter ligger under URL-en https://api.instatus.com. De følger stort sett REST-arkitekturen.

Alle forespørsler må kodes som JSON med headeren Content-Type: application/json.

Svar fra Instatus-API-et, inkludert feil, er også kodet som JSON.

Autentisering

Forespørsler til Instatus-API-et må sende en API-nøkkel i Authorization-headeren:

Authorization: Bearer <API_KEY>

Opprett nøkler i Dashbord › Utvikler med Opprett nøkkel. Du kan ha flere nøkler, hver med sitt eget navn, for eksempel «GitHub Actions» eller «Terraform». Nøkler begynner med inst_sk_.

Hva en nøkkel kan gjøre

Hver nøkkel har sine egne innstillinger:

  • Rolle: Medlem, Redaktør eller en egendefinert rolle på Business-planen. Rollen bestemmer hva nøkkelen kan se og endre, på samme måte som for personer. Nøkler kan ikke være Eier, så fakturering, roller og sletting forblir hos personer.
  • Tilgang: Se og endre eller Bare se. En nøkkel med Bare se kan ikke endre noe, uansett hva rollen tillater.
  • Prosjekter: alle prosjekter, også dem du legger til senere, eller bare dem du velger.
  • Utløpsdato: datoen nøkkelen slutter å virke. På Free-planen kan en nøkkel vare i opptil 90 dager, på Pro i opptil 1 år, og på Business og Enterprise så lenge du vil, også uten utløpsdato. En teameier kan sette en kortere grense i Teaminnstillinger › API-nøkler. Nøkler laget før nøkkelinnstillingene påvirkes ikke, og eksisterende nøkler beholder datoen sin når planen din endres.
  • Tillatte IP-adresser: på Business-planen virker nøkkelen bare fra IP-adressene eller områdene du oppgir.

En nøkkel tilhører teamet eller deg:

  • Teamnøkler fortsetter å virke når personen som laget dem, forlater teamet. Bruk dem til CI, skript og integrasjoner.
  • Personlige nøkler handler som deg og gjør aldri mer enn du kan. De kan bruke Samme som deg som rolle og slutter å virke hvis du forlater teamet.

Teameiere bestemmer reglene for nøkler i Teaminnstillinger › API-nøkler: hvor lenge en nøkkel maksimalt kan vare, om medlemmer kan lage teamnøkler, og om personlige nøkler er tillatt.

Når en nøkkel opprettes, endres, roteres eller tilbakekalles, vises det i teamets Aktivitet, og det samme gjør en nøkkel som ble tilbakekalt fordi den hadde lekket. Alt som gjøres via en nøkkel eller en tilkoblet app, vises der som person via navnet på nøkkelen eller appen.

Hold nøklene trygge

  • En nøkkel vises bare én gang, når du oppretter den. Kopier den da, og oppbevar den som en hemmelighet.
  • For å erstatte en nøkkel åpner du den og klikker Roter. Velg hvor lenge den gamle nøkkelen fortsetter å virke, opptil 7 dager, så du har tid til å oppdatere alt som bruker den.
  • Tilbakekall en nøkkel fra menyen, så slutter den å virke med en gang.

Nøkler laget før nøkkelinnstillingene fortsetter å virke som før. De vises som «Laget før nøkkelinnstillinger» under Utvikler, der du kan legge til begrensninger eller erstatte dem med en ny nøkkel.

Nøkkelfeil

Når en nøkkel ikke kan utføre en forespørsel, har feilen en av disse kodene, og meldingen forteller hva du må endre.

KodeStatusHvorfor
invalid_key401Nøkkelen finnes ikke. Sjekk at du kopierte hele nøkkelen.
key_expired401Nøkkelen har passert utløpsdatoen.
key_revoked401Nøkkelen er tilbakekalt.
key_owner_left401Personen en personlig nøkkel handler som, har forlatt teamet.
key_view_only403Nøkkelen har Bare se, og forespørselen endrer noe.
role_not_allowed403Nøkkelens rolle kan ikke se eller endre dette.
ip_not_allowed403Forespørselen kom fra en IP-adresse nøkkelen ikke tillater.
page_not_allowed403Nøkkelen kan ikke bruke dette prosjektet.
account_action_not_allowed403Nøkler kan ikke opprette eller fjerne sider, team eller arbeidsområder. Bruk dashbordet.
route_not_allowed403Ruten er ikke en del av det dokumenterte API-et.

Finn side-ID-en din

Du finner side-ID-en din i dashbordet slik:

  1. Gå til dashbordet ditt.
  2. Høyreklikk på prosjektet ditt øverst til venstre for å åpne menyen.
  3. Klikk Kopier prosjekt-ID, så kopieres side-ID-en din til utklippstavlen.
Side-ID

Feil

Alle API-endepunkter returnerer en kode og en melding i feilsvarene.

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

Statusverdier

Mulige sidestatuser. Dette er den detaljerte status-verdien som returneres av det gjeldende API-et (v2 og nyere). Det gamle summary.json-endepunktet og webhook-varslinger bruker en forenklet form med bare UP, HASISSUES og UNDERMAINTENANCE.

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

Mulige komponentstatuser:

  • OPERATIONAL
  • UNDERMAINTENANCE
  • DEGRADEDPERFORMANCE
  • PARTIALOUTAGE
  • MAJOROUTAGE

Mulige hendelsesstatuser:

  • INVESTIGATING
  • IDENTIFIED
  • MONITORING
  • RESOLVED

Mulige vedlikeholdsstatuser:

  • NOTSTARTEDYET
  • INPROGRESS
  • COMPLETED

Hopp til endepunktene: