Comece agora com a API da Instatus

Todos os endpoints ficam sob a URL https://api.instatus.com. Em geral, eles seguem a arquitetura REST.

Todas as requisições precisam ser codificadas em JSON com o cabeçalho Content-Type: application/json.

As respostas da API da Instatus, inclusive os erros, também são codificadas em JSON.

Autenticação

As requisições para a API da Instatus precisam informar um token de API no cabeçalho Authorization:

Você encontra sua chave de API em Configurações do usuário → Configurações de desenvolvedor

Authorization: Bearer <API_KEY>

Obtenha o ID da sua página

Você encontra o ID da sua página no painel seguindo estes passos:

1. Acesse seu painel.
2. Clique com o botão direito no seu projeto, no canto superior esquerdo, para abrir o menu.
3. Clique em Copy Project ID e o ID da página é copiado para a área de transferência.

Erros

Todos os endpoints da API trazem um código e uma mensagem dentro das respostas de erro.

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

Valores de status

Status possíveis da página. Este é o status detalhado retornado pela API atual (v2 em diante). O endpoint legado summary.json e as notificações por webhook usam uma forma condensada, com apenas UP, HASISSUES e UNDERMAINTENANCE.

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

Status possíveis do componente:

• OPERATIONAL
• UNDERMAINTENANCE
• DEGRADEDPERFORMANCE
• PARTIALOUTAGE
• MAJOROUTAGE

Status possíveis do incidente:

• INVESTIGATING
• IDENTIFIED
• MONITORING
• RESOLVED

Status possíveis da manutenção:

• NOTSTARTEDYET
• INPROGRESS
• COMPLETED

Ir para os endpoints: