Inizia con l'API di Instatus

Tutti gli endpoint si trovano all'URL https://api.instatus.com. In genere seguono l'architettura REST.

Tutte le richieste devono essere codificate in JSON con l'header Content-Type: application/json.

Anche le risposte dell'API di Instatus, errori compresi, sono codificate in JSON.

Autenticazione

Le richieste all'API di Instatus devono inviare una chiave API tramite l'header Authorization:

Authorization: Bearer <API_KEY>

Crea le chiavi in Dashboard › Sviluppatori con Crea chiave. Puoi avere più chiavi, ognuna con il proprio nome, come "GitHub Actions" o "Terraform". Le chiavi iniziano con inst_sk_.

Cosa può fare una chiave

Ogni chiave ha le proprie impostazioni:

  • Ruolo: Membro, Editor o un ruolo personalizzato con il piano Business. Il ruolo decide cosa la chiave può vedere e modificare, come avviene per le persone. Le chiavi non possono essere Proprietario, quindi fatturazione, ruoli ed eliminazioni restano alle persone.
  • Accesso: Vedere e modificare oppure Solo vedere. Una chiave "Solo vedere" non può modificare nulla, qualunque cosa consenta il suo ruolo.
  • Progetti: tutti i progetti, compresi quelli che aggiungerai in seguito, oppure solo quelli che scegli.
  • Scadenza: la data in cui la chiave smette di funzionare. Con il piano Free una chiave può durare fino a 90 giorni, con Pro fino a 1 anno e con Business ed Enterprise quanto vuoi, anche senza scadenza. Un proprietario del team può impostare un limite più breve in Impostazioni del team › Chiavi API. Le chiavi create prima delle impostazioni delle chiavi non sono interessate, e le chiavi esistenti mantengono la loro data quando cambi piano.
  • IP consentiti: con il piano Business, la chiave funziona solo dagli indirizzi IP o dagli intervalli che indichi.

Una chiave appartiene al team o a te:

  • Le chiavi del team continuano a funzionare quando chi le ha create lascia il team. Usale per CI, script e integrazioni.
  • Le chiavi personali agiscono come te e non fanno mai più di quanto puoi fare tu. Possono usare Come te come ruolo e smettono di funzionare se lasci il team.

I proprietari del team stabiliscono le regole per le chiavi in Impostazioni del team › Chiavi API: la durata massima di una chiave, se i membri possono creare chiavi del team e se le chiavi personali sono consentite.

La creazione, la modifica, la rotazione e la revoca di una chiave compaiono nella sezione Attività del team, così come una chiave revocata perché è trapelata. Tutto ciò che viene fatto tramite una chiave o un'app collegata compare lì come persona tramite nome della chiave o dell'app.

Tieni al sicuro le chiavi

  • Una chiave viene mostrata una sola volta, quando la crei. Copiala subito e conservala come un segreto.
  • Per sostituire una chiave, aprila e clicca su Ruota. Scegli per quanto tempo la vecchia chiave continua a funzionare, fino a 7 giorni, così hai il tempo di aggiornare tutto ciò che la usa.
  • Revoca una chiave dal suo menu e smette subito di funzionare.

Le chiavi create prima delle impostazioni delle chiavi continuano a funzionare come prima. In Sviluppatori compaiono come "Creata prima delle impostazioni delle chiavi", e lì puoi aggiungere dei limiti o sostituirle con una nuova chiave.

Errori delle chiavi

Quando una chiave non può eseguire una richiesta, l'errore ha uno di questi codici e il messaggio spiega cosa cambiare.

CodiceStatoMotivo
invalid_key401La chiave non esiste. Controlla di averla copiata per intero.
key_expired401La chiave ha superato la data di scadenza.
key_revoked401La chiave è stata revocata.
key_owner_left401La persona per cui agisce una chiave personale ha lasciato il team.
key_view_only403La chiave è "Solo vedere" e la richiesta modifica qualcosa.
role_not_allowed403Il ruolo della chiave non può vedere o modificare questo elemento.
ip_not_allowed403La richiesta arriva da un indirizzo IP che la chiave non consente.
page_not_allowed403La chiave non può usare questo progetto.
account_action_not_allowed403Le chiavi non possono creare o rimuovere pagine, team o workspace. Usa la dashboard.
route_not_allowed403La route non fa parte dell'API documentata.

Trova il tuo ID pagina

Puoi trovare l'ID pagina nella dashboard seguendo questi passaggi:

  1. Vai alla tua dashboard.
  2. Fai clic destro sul progetto in alto a sinistra per aprire il menu.
  3. Clicca su Copia ID progetto: l'ID della pagina viene copiato negli appunti.
ID pagina

Errori

Tutti gli endpoint dell'API includono un codice e un messaggio nelle risposte di errore.

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

Valori di stato

Stati possibili della pagina. È il valore status dettagliato restituito dall'API attuale (v2 e successive). L'endpoint legacy summary.json e le notifiche webhook usano una forma ridotta con soli UP, HASISSUES e UNDERMAINTENANCE.

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

Stati possibili dei componenti:

  • OPERATIONAL
  • UNDERMAINTENANCE
  • DEGRADEDPERFORMANCE
  • PARTIALOUTAGE
  • MAJOROUTAGE

Stati possibili degli incidenti:

  • INVESTIGATING
  • IDENTIFIED
  • MONITORING
  • RESOLVED

Stati possibili delle manutenzioni:

  • NOTSTARTEDYET
  • INPROGRESS
  • COMPLETED

Vai agli endpoint: