From b32770c281bfb7fb7b3108570e2fcfc9dbee871a Mon Sep 17 00:00:00 2001 From: James Brooks Date: Mon, 24 Aug 2026 10:38:06 +0100 Subject: [PATCH] Document bulk deletion API convention --- api-reference/introduction.mdx | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx index ecc6380..6222150 100644 --- a/api-reference/introduction.mdx +++ b/api-reference/introduction.mdx @@ -11,6 +11,24 @@ description: 'Learn how to interact with the Cachet API.' Cachet provides a RESTful JSON API that allows you to interact with the status page programmatically. The API is simple to use. +## Deleting resources + +Every resource with a delete endpoint supports deleting one resource by ID: + +```http +DELETE /api/components/123 +``` + +Component groups, components, incidents, incident templates, metrics, and schedules also support atomic bulk deletion +with a comma-separated `ids` query parameter: + +```http +DELETE /api/components?ids=123,456 +``` + +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 ```json