StatusDashboard
Components

Delete component

Permanently delete a component from the organization.

View Markdown

DELETE /app/components/{id}

Permanently deletes a component. Requires the admin role.

When a component is deleted, the platform automatically:

  • Removes it from every status dashboard in the organization that included it, including any widget component filters for that dashboard.
  • Cleans up subscriber records tied to that component on affected dashboards — for example, removing subscribers who only followed that component, or pruning the component from multi-component subscriptions.
  • Deletes the component record itself.

The following are not changed:

  • Existing events in admin are not deleted or rewritten. Events that referenced the component keep their stored name and severity snapshots from when they were last associated.
  • New events cannot reference a deleted component ID.

For how deletion affects public status page visibility and event history, see Deleting components and Dashboard scope.


Path parameters

ParameterTypeDescription
idstringUUID of the component to delete.

Request

See API Basics for required headers.


Sample request

curl -X DELETE https://api.statusdashboard.com/app/components/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer bcf847abf5c6:def456"

Sample response

Status: 204 No Content

No response body.


Error responses

StatusWhen
403Insufficient permissions.
404No component with that ID exists in the organization.

On this page

We use cookies

We use essential cookies to keep the site working, and optional analytics cookies to understand how it's used. Read our Privacy Policy.