Skip to content

Document bulk deletion API convention #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jbrooksuk merged 1 commit into from
Aug 24, 2026
Merged

Document bulk deletion API convention #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions api-reference/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

@chatgpt-codex-connector chatgpt-codex-connector Bot Aug 24, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Keep the generic response outside the deletion section

Placing this ## heading here makes the existing ### Example response a subsection of “Deleting resources,” although that payload is a paginated incident-list response rather than a deletion response. Readers navigating this page will therefore see an unrelated response presented as the result of the documented DELETE; move this section below the example or adjust the heading hierarchy so the example remains under “JSON API.”

Useful? React with 👍 / 👎.


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.

@chatgpt-codex-connector chatgpt-codex-connector Bot Aug 24, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Point to a reference that documents bulk-delete abilities

The promised ability information is not present in the checked API reference: api-reference/openapi.json exposes only get and post on each of the six listed collection paths, and its individual delete operations and shared authorization-error response do not name a required token ability. Users following this sentence therefore cannot determine which ability to grant and may receive a 403; either document the abilities here or add the bulk-delete operations and their ability requirements to the referenced specification.

Useful? React with 👍 / 👎.


### Example response

```json
Expand Down
Loading