Preview what deleting a database would affect
Walks everything that depends on the database - views, blocks, relations, automations and other references - and returns those entries with an overall status of `safe`, `needs_confirmation`, or `blocked`. Read-only: nothing is deleted. Requires the `databases:write` permission.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/workspaces/string/databases/string/deletion-impact"{ "data": { "target": { "kind": "workspace_item", "id": "string", "label": "string" }, "status": "safe", "summary": { "blockers": 0, "warnings": 0, "cascades": 0 }, "entries": [ { "id": "string", "kind": "workspace_item", "level": "blocking", "label": "string", "reason": "string", "action": "string", "remediation": { "capability": "actions.delete", "args": { "actionId": "string" } }, "owner": { "id": "string", "kind": "string", "label": "string" } } ] }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Delete a database
Computes the deletion impact first and refuses while blocking dependencies remain, or when the impact carries warnings and `confirmed` is not truthy; otherwise the database and its records are removed. Pass `confirmed=true` to accept the warnings the impact preview reported. Requires the `databases:write` permission.
List the fields of a database
Returns the database's fields in display order, each with its kind, options, default value, requiredness and kind-specific settings. Requires the `databases:read` permission.