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 enviar uma chave de API no cabeçalho Authorization:
Authorization: Bearer <API_KEY>
Crie chaves em Painel › Desenvolvedor com Criar chave. Você pode ter várias chaves, cada uma com seu próprio nome, como "GitHub Actions" ou "Terraform". As chaves começam com inst_sk_.
O que uma chave pode fazer
Cada chave tem suas próprias configurações:
- Função: Membro, Editor ou uma função personalizada no plano Business. A função define o que a chave pode ver e alterar, do mesmo jeito que acontece com as pessoas. Uma chave não pode ser Dono, então cobrança, funções e exclusões continuam com as pessoas.
- Acesso: Ver e alterar ou Somente ver. Uma chave Somente ver não pode alterar nada, seja o que for que a função dela permita.
- Projetos: todos os projetos, incluindo os que você adicionar depois, ou apenas os que você escolher.
- Validade: a data em que a chave para de funcionar. No plano Free, uma chave pode durar até 90 dias, no Pro até 1 ano e no Business e no Enterprise o tempo que você quiser, inclusive sem validade. Um dono do time pode definir um limite menor em Configurações do time › Chaves de API. Chaves criadas antes das configurações de chave não são afetadas, e as chaves existentes mantêm a data quando seu plano muda.
- IPs permitidos: no plano Business, a chave só funciona a partir dos endereços ou faixas de IP que você listar.
Uma chave pertence ao time ou a você:
- Chaves da equipe continuam funcionando quando a pessoa que as criou sai do time. Use-as em CI, scripts e integrações.
- Chaves pessoais agem como você e nunca fazem mais do que você pode. Elas podem usar Igual a você como função e param de funcionar se você sair do time.
Os donos do time definem as regras das chaves em Configurações do time › Chaves de API: por quanto tempo, no máximo, uma chave pode durar, se membros podem criar chaves do time e se chaves pessoais são permitidas.
A criação, a alteração, a rotação e a revogação de uma chave aparecem na Atividade do time, assim como uma chave revogada por ter vazado. Tudo o que é feito por uma chave ou por um app conectado aparece lá como pessoa via nome da chave ou do app.
Mantenha as chaves seguras
- Uma chave é mostrada uma única vez, quando você a cria. Copie-a nesse momento e guarde-a como um segredo.
- Para substituir uma chave, abra-a e clique em Rotacionar. Escolha por quanto tempo a chave antiga continua funcionando, até 7 dias, para ter tempo de atualizar tudo que a usa.
- Revogue uma chave pelo menu dela e ela para de funcionar na hora.
Chaves criadas antes das configurações de chave continuam funcionando sem mudanças. Elas aparecem como "Criada antes das configurações de chaves" em Desenvolvedor, onde você pode adicionar limites a elas ou substituí-las por uma nova chave.
Erros de chave
Quando uma chave não pode fazer uma requisição, o erro tem um destes códigos, e a mensagem diz o que mudar.
| Código | Status | Motivo |
|---|---|---|
invalid_key | 401 | A chave não existe. Confira se você a copiou inteira. |
key_expired | 401 | A chave passou da data de validade. |
key_revoked | 401 | A chave foi revogada. |
key_owner_left | 401 | A pessoa como quem uma chave pessoal age saiu do time. |
key_view_only | 403 | A chave é Somente ver e a requisição altera algo. |
role_not_allowed | 403 | A função da chave não pode ver ou alterar isso. |
ip_not_allowed | 403 | A requisição veio de um endereço IP que a chave não permite. |
page_not_allowed | 403 | A chave não pode usar este projeto. |
account_action_not_allowed | 403 | Chaves não podem criar nem remover páginas, times ou workspaces. Use o painel. |
route_not_allowed | 403 | A rota não faz parte da API documentada. |
Obtenha o ID da sua página
Você encontra o ID da sua página no painel seguindo estes passos:
- Acesse seu painel.
- Clique com o botão direito no seu projeto, no canto superior esquerdo, para abrir o menu.
- 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.
UPHASISSUESALLUNDERMAINTENANCEALLDEGRADEDPERFORMANCEALLPARTIALOUTAGEALLMINOROUTAGEALLMAJOROUTAGESOMEUNDERMAINTENANCESOMEDEGRADEDPERFORMANCESOMEPARTIALOUTAGESOMEMINOROUTAGESOMEMAJOROUTAGEONEUNDERMAINTENANCEONEDEGRADEDPERFORMANCEONEPARTIALOUTAGEONEMINOROUTAGEONEMAJOROUTAGE
Status possíveis do componente:
OPERATIONALUNDERMAINTENANCEDEGRADEDPERFORMANCEPARTIALOUTAGEMAJOROUTAGE
Status possíveis do incidente:
INVESTIGATINGIDENTIFIEDMONITORINGRESOLVED
Status possíveis da manutenção:
NOTSTARTEDYETINPROGRESSCOMPLETED