Dashboards
Delete dashboard
Permanently delete a dashboard and its associated resources.
DELETE /app/dashboards/{id}
Permanently deletes a dashboard. The caller must supply the dashboard's subdomain in the request body as an explicit confirmation — this guards against accidental or scripted deletion.
The dashboard record and public status page are removed immediately. When a custom domain with active hosting was configured, a background job tears down domain hosting and certificate setup asynchronously.
What is removed
| Area | Behavior |
|---|---|
| Dashboard configuration | All settings for this dashboard are deleted (domains, components, content, custom code, branding, widget, digital signs, network rules, support, subscriptions, SSO). |
| Uploaded images | Branding logos, favicon, email logo, and digital-sign logos for this dashboard are deleted from storage. |
| Subscribers | Email, SMS, WhatsApp, and integration subscribe endpoints for this dashboard are removed; org-wide unique subscriber slots are released when nothing else references the same address or URL. |
| Custom email sender | Removed for this dashboard; shared sending-domain verification is kept while other dashboards still use that domain. |
| Custom domain | Background teardown of domain hosting and TLS when provisioned; skipped when removal was already in progress. |
| SSO | Identity provider configuration for this dashboard is removed; the status page is no longer SSO-gated. |
Organization-scoped data (events, components, outbound notification integrations, delivery logs) is not deleted by this endpoint.
Path parameters
| Parameter | Description |
|---|---|
id | The UUID of the dashboard. |
Request
See API Basics for required headers.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
confirmSubdomain | string | Yes | Must exactly match the dashboard's subdomain. The request is rejected with 400 if absent or if the value does not match. |
Sample request
curl -X DELETE https://api.statusdashboard.com/app/dashboards/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
-H "Authorization: Bearer bcf847abf5c6:def456" \
-H "Content-Type: application/json" \
-d '{"confirmSubdomain":"acme"}'Sample response
Status: 204 No Content
No response body.
Error responses
| Status | When |
|---|---|
400 | confirmSubdomain is missing from the request body. |
400 | confirmSubdomain does not match the dashboard's subdomain. |
403 | Insufficient permissions. |
404 | Dashboard not found or does not belong to the caller's organization. |