Referência da API de componentes

Obter todos os componentes da sua página de status

Endpoint:

GET /v2/:page_id/components?page=:page&per_page=:per_page
  • O número de página padrão é 1.
  • O per_page padrão é 50 e o máximo é 100 itens por página.

Exemplo de resposta:

[
{
"id": "ckf01fvnxywz60a35wdbn5gz5",
"name": "App",
"status": "OPERATIONAL",
"uniqueEmail": "nasa-app-1nozrueut@automation.instatus.com",
"description": "",
"showUptime": true,
"order": 0,
"group": null
},
{
"id": "ckf01fvnxywz50a35nh1qzssm",
"name": "Website",
"status": "OPERATIONAL",
"description": "",
"showUptime": true,
"order": 0,
"group": null,
"uniqueEmail": "nasa-website-1nozrueut@automation.instatus.com"
}
]

Obter um componente

Endpoint:

GET /v2/:page_id/components/:component_id

Exemplo de resposta

{
"id": "ckf01fvnxywz50a35nh1qzssm",
"name": "Website",
"description": "",
"status": "OPERATIONAL",
"uniqueEmail": "nasa-website-1nozrueut@automation.instatus.com",
"showUptime": true,
"order": 0,
"group": null
}

Obter a disponibilidade da página de status

Endpoint:

GET /v2/:page_id/uptime?start=:start&end=:end
  • start e end são datas ISO 8601. Sem elas, você recebe os últimos 30 dias.
  • O período pode ter no máximo 395 dias, e start deve ser anterior a end.

Exemplo de resposta:

{
"start": "2026-10-01T00:00:00.000Z",
"end": "2026-10-31T00:00:00.000Z",
"uptime": 99.97,
"components": [
{
"id": "ckf01fvnxywz60a35wdbn5gz5",
"name": "App",
"uptime": 99.95,
"isParent": false,
"children": []
},
{
"id": "ckf01fvnxywz40a35p2c1xk7q",
"name": "API",
"uptime": 99.98,
"isParent": true,
"children": [
{
"id": "ckf01fvnxywz50a35nh1qzssm",
"name": "Auth",
"uptime": 99.96,
"isParent": false,
"children": []
},
{
"id": "ckf01fvnxywz70a35r8m2wq4d",
"name": "Search",
"uptime": 100,
"isParent": false,
"children": []
}
]
}
]
}
  • O uptime de nível superior abrange a página inteira: a média de todos os componentes, calculada da mesma forma que a disponibilidade de um grupo.
  • Grupos têm isParent como true e listam seus componentes em children.
  • Só contam as interrupções publicadas, então os números batem com a sua página de status.

Criar um componente

Endpoint:

POST /v1/:page_id/components

Exemplo de requisição:

{
"name": "Test component",
"description": "Testing",
"status": "OPERATIONAL",
"order": 6,
"showUptime": true,
"grouped": false,
"archived": false,
"translations": {
"name": {
"fr": "Composant de test"
},
"description": {
"fr": "En test"
}
}
}

Exemplo de resposta:

{
"id": "ckf1d4f6a4aaf0a356vqg0rdm",
"name": "Test component",
"description": "Testing",
"uniqueEmail": "nasa-test-component-oomaksikj@automation.instatus.com",
"status": "OPERATIONAL",
"showUptime": true,
"order": 8,
"group": null,
"translations": {
"name": {
"fr": "Composant de test"
},
"description": {
"fr": "En test"
}
}
}

Se quiser adicionar um componente dentro de um grupo, defina grouped como true e group com o ID do grupo desejado.

Atualizar um componente

Endpoint:

PUT /v2/:page_id/components/:component_id

Exemplo de requisição:

{
"name": "Test component 4",
"description": "Test test test",
"status": "OPERATIONAL",
"order": 6,
"showUptime": true,
"grouped": false,
"archived": true,
"translations": {
"name": {
"fr": "Composant de test 4"
},
"description": {
"fr": "Test test test"
}
}
}

Exemplo de resposta:

{
"id": "ckf1d4f6a4aaf0a356vqg0rdm",
"name": "Test component 4",
"uniqueEmail": "nasa-test-component-oomaksikj@automation.instatus.com",
"status": "OPERATIONAL",
"description": "Test test test",
"showUptime": true,
"order": 6,
"group": null,
"translations": {
"name": {
"fr": "Composant de test 4"
},
"description": {
"fr": "Test test test"
}
}
}

Se quiser mudar o grupo de um componente, defina grouped como true e groupId com o ID do grupo desejado.

Excluir um componente

Endpoint:

DELETE /v1/:page_id/components/:component_id
{
"id": "ckf1d4f6a4aaf0a356vqg0rdm"
}