Skip to main content
DELETE
/
v2
/
dashboard
/
{dashboard_id}
Delete Dashboard
const options = {
  method: 'DELETE',
  headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};

fetch('https://api.dcycle.io/v2/dashboard/{dashboard_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Delete Dashboard

Delete a dashboard permanently. Only the organization that owns the associated project can delete the dashboard.
This permanently removes the dashboard and all its widgets and layout configurations. This action cannot be undone.

Request

Headers

x-api-key
string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
x-organization-id
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Path Parameters

dashboard_id
string
required
UUID of the dashboard to deleteExample: "550e8400-e29b-41d4-a716-446655440000"

Response

Returns HTTP 204 No Content on success.

Example

curl -X DELETE "https://api.dcycle.io/v2/dashboard/550e8400-e29b-41d4-a716-446655440000" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}"

Common Errors

401 Unauthorized

Cause: Missing or invalid API key
{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}

403 Forbidden

Cause: The user is not a member of the organization, or your organization is not the owner of this dashboard’s project
{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}
{
  "detail": "Only the owning organization can modify this dashboard."
}

404 Not Found

Cause: Dashboard does not exist
{
  "detail": "Not found."
}

List Dashboards

View all dashboards

Create Dashboard

Create a new dashboard