Aloita Instatus-API:n käyttö

Kaikki päätepisteet ovat URL-osoitteen https://api.instatus.com alla. Ne noudattavat pääosin REST-arkkitehtuuria.

Kaikki pyynnöt on koodattava JSON-muotoon ja niissä on käytettävä otsaketta Content-Type: application/json.

Myös Instatus-API:n vastaukset, virheet mukaan lukien, on koodattu JSON-muotoon.

Todennus

Instatus-API:n pyynnöissä on lähetettävä API-avain Authorization-otsakkeessa:

Authorization: Bearer <API_KEY>

Luo avaimet kohdassa Hallintapaneeli › Kehittäjä painikkeella Luo avain. Sinulla voi olla useita avaimia, joilla kullakin on oma nimensä, kuten ”GitHub Actions” tai ”Terraform”. Avaimet alkavat merkkijonolla inst_sk_.

Mitä avain voi tehdä

Jokaisella avaimella on omat asetuksensa:

  • Rooli: Jäsen, Muokkaaja tai Business-paketin mukautettu rooli. Rooli määrää, mitä avain voi katsoa ja muuttaa, samalla tavalla kuin ihmisillä. Avain ei voi olla Omistaja, joten laskutus, roolit ja poistaminen jäävät ihmisille.
  • Käyttöoikeus: Näytä ja muuta tai Vain näytä. Vain näytä -avain ei voi muuttaa mitään, salli sen rooli mitä tahansa.
  • Projektit: kaikki projektit, myös myöhemmin lisäämäsi, tai vain valitsemasi.
  • Vanhentuminen: päivä, jona avain lakkaa toimimasta. Free-paketissa avain voi olla voimassa enintään 90 päivää, Pro-paketissa enintään vuoden ja Business- ja Enterprise-paketeissa niin kauan kuin haluat, myös ilman vanhentumista. Tiimin omistaja voi asettaa lyhyemmän rajan kohdassa Tiimin asetukset › API-avaimet. Tämä ei koske ennen avainasetuksia tehtyjä avaimia, ja olemassa olevat avaimet säilyttävät päivämääränsä, kun pakettisi vaihtuu.
  • Sallitut IP-osoitteet: Business-paketissa avain toimii vain luettelemistasi IP-osoitteista tai -alueista.

Avain kuuluu joko tiimille tai sinulle:

  • Tiimiavaimet toimivat edelleen, kun avaimen tehnyt henkilö lähtee tiimistä. Käytä niitä CI:hin, skripteihin ja integraatioihin.
  • Henkilökohtaiset avaimet toimivat sinuna eivätkä koskaan tee enempää kuin sinä. Niiden roolina voi olla Sama kuin sinulla, ja ne lakkaavat toimimasta, jos lähdet tiimistä.

Tiimin omistajat määrittävät avainten säännöt kohdassa Tiimin asetukset › API-avaimet: kuinka kauan avain voi enintään olla voimassa, saavatko jäsenet tehdä tiimin avaimia ja ovatko henkilökohtaiset avaimet sallittuja.

Avaimen luominen, muuttaminen, kierrättäminen ja peruminen näkyvät tiimin Toiminta-sivulla, samoin avain, joka peruttiin, koska se vuoti. Kaikki, mitä avaimella tai yhdistetyllä sovelluksella tehdään, näkyy siellä muodossa henkilö avaimen tai sovelluksen nimen kautta.

Pidä avaimet turvassa

  • Avain näytetään vain kerran, kun luot sen. Kopioi se silloin ja säilytä sitä salaisuutena.
  • Jos haluat vaihtaa avaimen, avaa se ja napsauta Kierrätä. Valitse, kuinka kauan vanha avain vielä toimii, enintään 7 päivää, jotta ehdit päivittää kaiken, mikä sitä käyttää.
  • Peru avain sen valikosta, niin se lakkaa toimimasta heti.

Ennen avainasetuksia tehdyt avaimet toimivat edelleen ennallaan. Ne näkyvät Kehittäjä-sivulla merkinnällä ”Luotu ennen avainasetuksia”, ja siellä voit lisätä niille rajoituksia tai korvata ne uudella avaimella.

Avainvirheet

Kun avain ei voi tehdä pyyntöä, virheessä on jokin näistä koodeista, ja sen viesti kertoo, mitä pitää muuttaa.

KoodiTilaSyy
invalid_key401Avainta ei ole olemassa. Tarkista, että kopioit sen kokonaan.
key_expired401Avaimen vanhentumispäivä on ohitettu.
key_revoked401Avain on peruttu.
key_owner_left401Henkilö, jona henkilökohtainen avain toimii, on lähtenyt tiimistä.
key_view_only403Avain on Vain näytä -avain, ja pyyntö muuttaa jotain.
role_not_allowed403Avaimen rooli ei salli tämän katselemista tai muuttamista.
ip_not_allowed403Pyyntö tuli IP-osoitteesta, jota avain ei salli.
page_not_allowed403Avain ei voi käyttää tätä projektia.
account_action_not_allowed403Avaimet eivät voi luoda tai poistaa sivuja, tiimejä tai työtiloja. Käytä hallintapaneelia.
route_not_allowed403Reitti ei kuulu dokumentoituun API:in.

Hae sivun ID

Löydät sivun ID:n hallintapaneelista näillä vaiheilla:

  1. Siirry hallintapaneeliin.
  2. Napsauta projektiasi vasemmassa yläkulmassa hiiren oikealla painikkeella avataksesi valikon.
  3. Napsauta Kopioi projektin ID, niin sivun ID kopioituu leikepöydällesi.
Sivun ID

Virheet

Kaikki API-päätepisteet sisältävät koodin ja viestin virhevastauksissaan.

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

Tila-arvot

Mahdolliset sivun tilat. Tämä on tarkka status, jonka nykyinen API (v2 ja uudemmat) palauttaa. Vanha summary.json-päätepiste ja webhook-ilmoitukset käyttävät tiivistettyä muotoa, jossa on vain UP, HASISSUES ja UNDERMAINTENANCE.

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

Mahdolliset komponentin tilat:

  • OPERATIONAL
  • UNDERMAINTENANCE
  • DEGRADEDPERFORMANCE
  • PARTIALOUTAGE
  • MAJOROUTAGE

Mahdolliset häiriön tilat:

  • INVESTIGATING
  • IDENTIFIED
  • MONITORING
  • RESOLVED

Mahdolliset huollon tilat:

  • NOTSTARTEDYET
  • INPROGRESS
  • COMPLETED

Siirry päätepisteisiin: