Skip to main content
DELETE
/
v1
/
dashboards
/
{id}
DELETE /v1/dashboards/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Dashboards

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Soft delete by ID
Dashboards.delete("03fb5cc3-de48-423f-9926-8e192e5de59d")

# Hard delete
Dashboards.delete(
    "03fb5cc3-de48-423f-9926-8e192e5de59d",
    hard_delete=True
)

# Delete by name
Dashboards.delete_by_name("sample_superset.10")

# Delete by name with options
Dashboards.delete_by_name(
    "sample_superset.10",
    hard_delete=True
)

# Restore a soft-deleted dashboard
Dashboards.restore("03fb5cc3-de48-423f-9926-8e192e5de59d")

{
  "id": "03fb5cc3-de48-423f-9926-8e192e5de59d",
  "name": "10",
  "displayName": "deck.gl Demo",
  "fullyQualifiedName": "sample_superset.10",
  "description": "",
  "version": 0.2,
  "updatedAt": 1769982666437,
  "updatedBy": "admin",
  "sourceUrl": "http://localhost:808/superset/dashboard/10/",
  "service": {
    "id": "b1e6a71d-7f47-4e5f-8ce0-e6e8a88ec97a",
    "type": "dashboardService",
    "name": "sample_superset",
    "fullyQualifiedName": "sample_superset"
  },
  "serviceType": "Superset",
  "deleted": true,
  "owners": [],
  "tags": [],
  "domains": []
}

​
Delete a Dashboard

Delete a dashboard by ID or fully qualified name. Supports soft delete (default), hard delete, and restore operations.

​
Delete by ID

​
id
string
required
UUID of the dashboard to delete.
​
recursive
boolean
default:"false"
Recursively delete child entities.
​
hardDelete
boolean
default:"false"
Permanently delete the dashboard. If false, the dashboard is soft-deleted and can be restored.

​
Delete by Name

Use DELETE /v1/dashboards/name/{fqn} to delete by fully qualified name.
​
fqn
string
required
Fully qualified name of the dashboard (e.g., sample_superset.10).
​
recursive
boolean
default:"false"
Recursively delete child entities.
​
hardDelete
boolean
default:"false"
Permanently delete the dashboard.

​
Restore a Soft-Deleted Dashboard

Use PUT /v1/dashboards/restore to restore a soft-deleted dashboard.
​
id
string
required
UUID of the soft-deleted dashboard to restore.
DELETE /v1/dashboards/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Dashboards

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Soft delete by ID
Dashboards.delete("03fb5cc3-de48-423f-9926-8e192e5de59d")

# Hard delete
Dashboards.delete(
    "03fb5cc3-de48-423f-9926-8e192e5de59d",
    hard_delete=True
)

# Delete by name
Dashboards.delete_by_name("sample_superset.10")

# Delete by name with options
Dashboards.delete_by_name(
    "sample_superset.10",
    hard_delete=True
)

# Restore a soft-deleted dashboard
Dashboards.restore("03fb5cc3-de48-423f-9926-8e192e5de59d")

{
  "id": "03fb5cc3-de48-423f-9926-8e192e5de59d",
  "name": "10",
  "displayName": "deck.gl Demo",
  "fullyQualifiedName": "sample_superset.10",
  "description": "",
  "version": 0.2,
  "updatedAt": 1769982666437,
  "updatedBy": "admin",
  "sourceUrl": "http://localhost:808/superset/dashboard/10/",
  "service": {
    "id": "b1e6a71d-7f47-4e5f-8ce0-e6e8a88ec97a",
    "type": "dashboardService",
    "name": "sample_superset",
    "fullyQualifiedName": "sample_superset"
  },
  "serviceType": "Superset",
  "deleted": true,
  "owners": [],
  "tags": [],
  "domains": []
}

​
Returns

Soft delete returns the dashboard object with deleted: true. Hard delete returns no content (204). Restore returns the restored dashboard object.

​
Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to delete this dashboard
404NOT_FOUNDDashboard with given ID or FQN does not exist