API/v3/incidents
Incidents API
The Incidents API allows you to programmatically manage incidents on your status pages. You can list, create, update, and delete incidents, as well as add and manage incident updates.
Base URL
https://api.hyperping.ioAuthentication
All API requests require authentication using your API key. Include it in the Authorization header:
Header
Authorization: Bearer $USER_API_KEYAPI tokens are set at the project level. To obtain your API token, go to the Developers tab in your project settings.
Endpoints
GET
Get all incidents
/v3/incidents
GET
Get an incident
/v3/incidents/{incident_uuid}
POST
Create an incident
/v3/incidents
PUT
Update an incident
/v3/incidents/{incident_uuid}
DELETE
Delete an incident
/v3/incidents/{incident_uuid}
POST
Add an update
/v3/incidents/{incident_uuid}/updates
Update Types
When adding or modifying incident updates, use one of these types:
