Endpoint:
GET /v1/:page_id/components
Example response:
[{"id": "ckf01fvnxywz60a35wdbn5gz5","name": "App","status": "OPERATIONAL","uniqueEmail": "nasa-app-1nozrueut@automation.instatus.com","description": "","showUptime": true,"order": 0,"group": null,"incidents": []},{"id": "ckf01fvnxywz50a35nh1qzssm","name": "Website","status": "OPERATIONAL","description": "","showUptime": true,"order": 0,"group": null,"uniqueEmail": "nasa-website-1nozrueut@automation.instatus.com","incidents": [{"id": "ckf01m59ueaqb0a32wrljz1yd","name": "Rocket is going down","started": "2020-09-12T19:05:17.398Z","status": "RESOLVED","components": [{"id": "ckf01fvnxywz50a35nh1qzssm","name": "Website","status": "OPERATIONAL","showUptime": true}],"updates": [{"id": "ckf01m5ioeaqi0a32jtv8ovp8","message": "We are currently investigating this incident.","messageHtml": "<p>We are currently investigating this incident.</p>","status": "INVESTIGATING","started": "2020-09-12T19:05:17.398Z"},{"id": "ckf01mnk9eaui0a32mmhgq68g","message": "We just resolved the issue!","messageHtml": "<p>We just resolved the issue!</p>","status": "RESOLVED","started": "2020-09-12T19:09:04.498Z"}]},{"id": "ckf02l5m8z36j0a35qr9q1tq1","name": "Test incident","started": "2020-09-12T03:38:47.998Z","status": "INVESTIGATING","components": [{"id": "ckf01fvnxywz50a35nh1qzssm","name": "Website","status": "OPERATIONAL","showUptime": true}],"updates": [{"id": "ckf02l5tregrr0a3292xt1207","message": "We're currently investigating an issue with the Website","messageHtml": "<p>We're currently investigating an issue with the Website</p>","status": "INVESTIGATING","started": "2020-09-12T03:38:47.998Z"}]}]}]
Endpoint:
GET /v1/: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,"incidents": [{"id": "ckf01m59ueaqb0a32wrljz1yd","name": "Rocket is going down","started": "2020-09-12T19:05:17.398Z","resolved": "2020-09-12T19:09:04.498Z","status": "RESOLVED","updates": [{"id": "ckf01m5ioeaqi0a32jtv8ovp8","message": "We are currently investigating this incident.","messageHtml": "<p>We are currently investigating this incident.</p>","status": "INVESTIGATING","started": "2020-09-12T19:05:17.398Z"},{"id": "ckf01mnk9eaui0a32mmhgq68g","message": "We just resolved the issue!","messageHtml": "<p>We just resolved the issue!</p>","status": "RESOLVED","started": "2020-09-12T19:09:04.498Z"}],"components": [{"id": "ckf01fvnxywz50a35nh1qzssm","name": "Website","status": "OPERATIONAL","showUptime": true}]},{"id": "ckf02l5m8z36j0a35qr9q1tq1","name": "Test incident","started": "2020-09-12T03:38:47.998Z","resolved": null,"status": "INVESTIGATING","updates": [{"id": "ckf02l5tregrr0a3292xt1207","message": "We're currently investigating an issue with the Website","messageHtml": "<p>We're currently investigating an issue with the Website</p>","status": "INVESTIGATING","started": "2020-09-12T03:38:47.998Z"}],"components": [{"id": "ckf01fvnxywz50a35nh1qzssm","name": "Website","status": "OPERATIONAL","showUptime": true}]}]}
Endpoint:
POST /v1/:page_id/components
Example request:
{"name": "Test component","description": "Testing","status": "OPERATIONAL","order": 6,"showUptime": true,"grouped": false}
Example response:
{"id": "ckf1d4f6a4aaf0a356vqg0rdm","name": "Test component 3","description": "Test test test","uniqueEmail": "nasa-test-component-oomaksikj@automation.instatus.com","status": "OPERATIONAL","showUptime": true,"order": 8,"group": null,"incidents": []}
If you'd like to add a component under grouped, you may set grouped
to true
and group
to your desired group name.
If the group name already exists, The component will be added to the existing group.
Endpoint:
PUT /v1/:page_id/components/:component_id
Example request:
{"name": "Test component 4","description": "Test test test","status": "OPERATIONAL","order": 6,"showUptime": true,"grouped": false}
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,"incidents": []}
Endpoint:
DELETE /v1/:page_id/components/:component_id
{"id": "ckf1d4f6a4aaf0a356vqg0rdm"}
Talk to a human
or send an email
Learn more
Check help and API docs
Community
Open page, twitter, changes & blog
Fine print
Privacy and terms