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));

import requests

url = "https://api.dcycle.io/v2/dashboard/{dashboard_id}"

headers = {
    "x-api-key": "<x-api-key>",
    "x-organization-id": "<x-organization-id>"
}

response = requests.delete(url, headers=headers)

print(response.text)

DELETE

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));

import requests

url = "https://api.dcycle.io/v2/dashboard/{dashboard_id}"

headers = {
    "x-api-key": "<x-api-key>",
    "x-organization-id": "<x-organization-id>"
}

response = requests.delete(url, headers=headers)

print(response.text)

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

string

required

Your API key for authenticationExample: sk_live_1234567890abcdef

string

required

Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Path Parameters

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}"

import requests
import os

headers = {
    "x-api-key": os.getenv("DCYCLE_API_KEY"),
    "x-organization-id": os.getenv("DCYCLE_ORG_ID"),
}

dashboard_id = "550e8400-e29b-41d4-a716-446655440000"

response = requests.delete(
    f"https://api.dcycle.io/v2/dashboard/{dashboard_id}",
    headers=headers,
)

if response.status_code == 204:
    print("Dashboard deleted successfully")

const axios = require('axios');

const headers = {
  'x-api-key': process.env.DCYCLE_API_KEY,
  'x-organization-id': process.env.DCYCLE_ORG_ID,
};

const dashboardId = '550e8400-e29b-41d4-a716-446655440000';

axios.delete(`https://api.dcycle.io/v2/dashboard/${dashboardId}`, { headers })
  .then(() => console.log('Dashboard deleted'));

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

​Delete Dashboard

​Request

​Headers

​Path Parameters

​Response

​Example

​Common Errors

​401 Unauthorized

​403 Forbidden

​404 Not Found

​Related Endpoints

List Dashboards

Create Dashboard

Delete Dashboard

Request

Headers

Path Parameters

Response

Example

Common Errors

401 Unauthorized

403 Forbidden

404 Not Found

Related Endpoints