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 annettava API-token Authorization-otsakkeessa:

Saat API-avaimesi kohdasta Käyttäjäasetukset → Kehittäjäasetukset

Authorization: Bearer <API_KEY>

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.

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: