Skip to main content
DELETE
/
v1
/
services
/
dashboardServices
/
{id}
DELETE /v1/services/dashboardServices/{id}
from metadata.sdk import configure
import requests

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

# Soft delete by ID
response = requests.delete(
    "https://your-company.getcollate.io/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd",
    headers={"Authorization": "Bearer your-jwt-token"}
)

# Hard delete
response = requests.delete(
    "https://your-company.getcollate.io/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd?hardDelete=true",
    headers={"Authorization": "Bearer your-jwt-token"}
)

# Delete by name
response = requests.delete(
    "https://your-company.getcollate.io/api/v1/services/dashboardServices/name/sample_looker",
    headers={"Authorization": "Bearer your-jwt-token"}
)

# Restore
response = requests.put(
    "https://your-company.getcollate.io/api/v1/services/dashboardServices/restore",
    headers={"Authorization": "Bearer your-jwt-token"},
    json={"id": "2c0c7c05-d820-4bea-a471-047deb7f92fd"}
)

{
  "id": "2c0c7c05-d820-4bea-a471-047deb7f92fd",
  "name": "sample_looker",
  "fullyQualifiedName": "sample_looker",
  "serviceType": "Looker",
  "version": 0.2,
  "updatedAt": 1769982621219,
  "updatedBy": "admin",
  "deleted": true,
  "owners": [],
  "tags": [],
  "domains": []
}

​
Delete a Dashboard Service

Delete a dashboard service 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 service to delete.
​
recursive
boolean
default:"false"
Recursively delete child entities (dashboards, charts).
​
hardDelete
boolean
default:"false"
Permanently delete the dashboard service. If false, the service is soft-deleted and can be restored.

​
Delete by Name

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

​
Restore a Soft-Deleted Dashboard Service

Use PUT /v1/services/dashboardServices/restore to restore a soft-deleted dashboard service.
​
id
string
required
UUID of the soft-deleted dashboard service to restore.
DELETE /v1/services/dashboardServices/{id}
from metadata.sdk import configure
import requests

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

# Soft delete by ID
response = requests.delete(
    "https://your-company.getcollate.io/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd",
    headers={"Authorization": "Bearer your-jwt-token"}
)

# Hard delete
response = requests.delete(
    "https://your-company.getcollate.io/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd?hardDelete=true",
    headers={"Authorization": "Bearer your-jwt-token"}
)

# Delete by name
response = requests.delete(
    "https://your-company.getcollate.io/api/v1/services/dashboardServices/name/sample_looker",
    headers={"Authorization": "Bearer your-jwt-token"}
)

# Restore
response = requests.put(
    "https://your-company.getcollate.io/api/v1/services/dashboardServices/restore",
    headers={"Authorization": "Bearer your-jwt-token"},
    json={"id": "2c0c7c05-d820-4bea-a471-047deb7f92fd"}
)

{
  "id": "2c0c7c05-d820-4bea-a471-047deb7f92fd",
  "name": "sample_looker",
  "fullyQualifiedName": "sample_looker",
  "serviceType": "Looker",
  "version": 0.2,
  "updatedAt": 1769982621219,
  "updatedBy": "admin",
  "deleted": true,
  "owners": [],
  "tags": [],
  "domains": []
}

​
Returns

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

​
Error Handling

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