This documentation refers to the Cachet v3 API. If you are looking for the Cachet v2 API, please refer to the previous Cachet API documentation.
JSON API
Cachet provides a RESTful JSON API that allows you to interact with the status page programmatically. The API is simple to use.Example response
{
"data": [
{
"id": "2",
"type": "incidents",
"attributes": {
"id": 2,
"guid": "3aad01a9-be10-422b-a90b-413c850cf89b",
"name": "Documentation Performance Degradation",
"message": "We're investigating an issue with our documentation causing the site to be slow.",
"component_id": null,
"visible": 1,
"stickied": false,
"notifications": 0,
"status": {
"human": "Investigating",
"value": 1
},
"occurred": {
"human": "34 minutes ago",
"string": "2024-10-27 08:31:59"
},
"created": {
"human": "34 minutes ago",
"string": "2024-10-27 08:31:59"
},
"updated": {
"human": "34 minutes ago",
"string": "2024-10-27 08:31:59"
}
}
},
{
"id": "1",
"type": "incidents",
"attributes": {
"id": 1,
"guid": "105d8c6d-9d21-4afd-a8d9-8c49f1fd1fbc",
"name": "DNS Provider Outage",
"message": "We're investigating an issue with our DNS provider causing the site to be offline.",
"component_id": null,
"visible": 1,
"stickied": false,
"notifications": 0,
"status": {
"human": "Fixed",
"value": 4
},
"occurred": {
"human": "1 day ago",
"string": "2024-10-26 09:01:59"
},
"created": {
"human": "1 day ago",
"string": "2024-10-26 09:01:59"
},
"updated": {
"human": "1 day ago",
"string": "2024-10-26 09:01:59"
}
}
}
],
"links": {
"first": "https://v3.cachethq.io/api/incidents?page=1"
},
"meta": {
"current_page": 1,
"from": 1,
"path": "https://v3.cachethq.io/api/incidents",
"per_page": 15,
"to": 2
}
}