Skip to main content
This reference covers the Cachet v3 API. For v2, see the Cachet v2 API documentation.

JSON API

The Cachet API reads and updates status page resources through HTTP requests. Responses use JSON.

Deleting resources

Resource deletion endpoints accept a resource ID:
Component groups, components, incidents, incident templates, metrics, and schedules also support atomic bulk deletion with a comma-separated ids query parameter:
All requested IDs must be valid and exist before Cachet deletes anything. An unqualified collection DELETE is rejected, and ids=all is not supported. See the relevant endpoint reference for the required API-token ability.

Example response

The incident list endpoint returns resources, pagination links, and metadata: