DELETE /v1/dashboards/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Dashboards
configure(
host="https://your-company.open-metadata.org/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")
import static org.openmetadata.sdk.fluent.Dashboards.*;
// Soft delete
Dashboards.delete("03fb5cc3-de48-423f-9926-8e192e5de59d").execute();
// Hard delete
Dashboards.delete("03fb5cc3-de48-423f-9926-8e192e5de59d")
.hardDelete()
.execute();
// Delete by name
Dashboards.deleteByName("sample_superset.10")
.execute();
// Restore
Dashboards.restore("03fb5cc3-de48-423f-9926-8e192e5de59d");
# Soft delete by ID
curl -X DELETE "{base_url}/api/v1/dashboards/03fb5cc3-de48-423f-9926-8e192e5de59d" \
-H "Authorization: Bearer {access_token}"
# Hard delete
curl -X DELETE "{base_url}/api/v1/dashboards/03fb5cc3-de48-423f-9926-8e192e5de59d?hardDelete=true" \
-H "Authorization: Bearer {access_token}"
# Delete by name
curl -X DELETE "{base_url}/api/v1/dashboards/name/sample_superset.10" \
-H "Authorization: Bearer {access_token}"
# Restore soft-deleted dashboard
curl -X PUT "{base_url}/api/v1/dashboards/restore" \
-H "Authorization: Bearer {access_token}" \
-H "Content-Type: application/json" \
-d '{"id": "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 name, with soft/hard delete options
DELETE
/
v1
/
dashboards
/
{id}
DELETE /v1/dashboards/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Dashboards
configure(
host="https://your-company.open-metadata.org/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")
import static org.openmetadata.sdk.fluent.Dashboards.*;
// Soft delete
Dashboards.delete("03fb5cc3-de48-423f-9926-8e192e5de59d").execute();
// Hard delete
Dashboards.delete("03fb5cc3-de48-423f-9926-8e192e5de59d")
.hardDelete()
.execute();
// Delete by name
Dashboards.deleteByName("sample_superset.10")
.execute();
// Restore
Dashboards.restore("03fb5cc3-de48-423f-9926-8e192e5de59d");
# Soft delete by ID
curl -X DELETE "{base_url}/api/v1/dashboards/03fb5cc3-de48-423f-9926-8e192e5de59d" \
-H "Authorization: Bearer {access_token}"
# Hard delete
curl -X DELETE "{base_url}/api/v1/dashboards/03fb5cc3-de48-423f-9926-8e192e5de59d?hardDelete=true" \
-H "Authorization: Bearer {access_token}"
# Delete by name
curl -X DELETE "{base_url}/api/v1/dashboards/name/sample_superset.10" \
-H "Authorization: Bearer {access_token}"
# Restore soft-deleted dashboard
curl -X PUT "{base_url}/api/v1/dashboards/restore" \
-H "Authorization: Bearer {access_token}" \
-H "Content-Type: application/json" \
-d '{"id": "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
string
required
UUID of the dashboard to delete.
boolean
default:"false"
Recursively delete child entities.
boolean
default:"false"
Permanently delete the dashboard. If
false, the dashboard is soft-deleted and can be restored.Delete by Name
UseDELETE /v1/dashboards/name/{fqn} to delete by fully qualified name.
string
required
Fully qualified name of the dashboard (e.g.,
sample_superset.10).boolean
default:"false"
Recursively delete child entities.
boolean
default:"false"
Permanently delete the dashboard.
Restore a Soft-Deleted Dashboard
UsePUT /v1/dashboards/restore to restore a soft-deleted dashboard.
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.open-metadata.org/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")
import static org.openmetadata.sdk.fluent.Dashboards.*;
// Soft delete
Dashboards.delete("03fb5cc3-de48-423f-9926-8e192e5de59d").execute();
// Hard delete
Dashboards.delete("03fb5cc3-de48-423f-9926-8e192e5de59d")
.hardDelete()
.execute();
// Delete by name
Dashboards.deleteByName("sample_superset.10")
.execute();
// Restore
Dashboards.restore("03fb5cc3-de48-423f-9926-8e192e5de59d");
# Soft delete by ID
curl -X DELETE "{base_url}/api/v1/dashboards/03fb5cc3-de48-423f-9926-8e192e5de59d" \
-H "Authorization: Bearer {access_token}"
# Hard delete
curl -X DELETE "{base_url}/api/v1/dashboards/03fb5cc3-de48-423f-9926-8e192e5de59d?hardDelete=true" \
-H "Authorization: Bearer {access_token}"
# Delete by name
curl -X DELETE "{base_url}/api/v1/dashboards/name/sample_superset.10" \
-H "Authorization: Bearer {access_token}"
# Restore soft-deleted dashboard
curl -X PUT "{base_url}/api/v1/dashboards/restore" \
-H "Authorization: Bearer {access_token}" \
-H "Content-Type: application/json" \
-d '{"id": "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 withdeleted: true. Hard delete returns no content (204). Restore returns the restored dashboard object.
Error Handling
| Code | Error Type | Description |
|---|---|---|
401 | UNAUTHORIZED | Invalid or missing authentication token |
403 | FORBIDDEN | User lacks permission to delete this dashboard |
404 | NOT_FOUND | Dashboard with given ID or FQN does not exist |
Was this page helpful?
⌘I