Components API Reference
Get all your status page components
Endpoint:
GET /v2/:page_id/components?page=:page&per_page=:per_page
- The default page number is 1.
- The default per_page number is 50 and the maximum is 100 items per page.
Example response:
[{"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"}]
Get a component
Endpoint:
GET /v2/:page_id/components/:component_id
Example response
{"id": "ckf01fvnxywz50a35nh1qzssm","name": "Website","description": "","status": "OPERATIONAL","uniqueEmail": "nasa-website-1nozrueut@automation.instatus.com","showUptime": true,"order": 0,"group": null}
Get status page uptime
Endpoint:
GET /v2/:page_id/uptime?start=:start&end=:end
startandendare ISO 8601 dates. Without them, you get the last 30 days.- The range can be at most 395 days, and
startmust be beforeend.
Example response:
{"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": []}]}]}
- The top-level
uptimecovers the whole page: the average of every component, worked out the same way as a group's uptime. - Groups have
isParentset totrueand list their components underchildren. - Only published outages count, so the figures match your status page.
Create a component
Endpoint:
POST /v1/:page_id/components
Example request:
{"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"}}}
Example response:
{"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"}}}
If you'd like to add a component under a group, you may set grouped to true and group to your desired group's ID.
Update a component
Endpoint:
PUT /v2/:page_id/components/:component_id
Example request:
{"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"}}}
Example response:
{"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"}}}
If you'd like to update a component's group, you may set grouped to true and groupId to your desired group's ID.
Delete a component
Endpoint:
DELETE /v1/:page_id/components/:component_id
{"id": "ckf1d4f6a4aaf0a356vqg0rdm"}