Delete a relation and both of its fields
Removes the relation as a whole - both end fields and every link between records - in one transaction; there is no way to delete a single side. Requires the `databases:write` permission on both databases the relation joins, and responds with not-found when the relation has no end on the database in the path. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.
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 DELETE "https://example.com/v1/workspaces/string/databases/string/relations/string"{ "data": { "id": "string", "workspaceId": "string", "label": "string", "fromDatabaseId": "string", "fromFieldId": "string", "fromCardinality": "one", "toDatabaseId": "string", "toFieldId": "string", "toCardinality": "one", "onDelete": "detach", "createdAt": "string", "updatedAt": "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}Update a relation's label and delete behavior
Renames the link and changes its `onDelete` behavior; the two ends, their fields and their cardinalities are immutable. Requires the `databases:write` permission on both databases the relation joins, and responds with not-found when the relation has no end on the database in the path. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.
List a database's buttons
Returns the buttons defined on the database in display order, each with the action it runs, its input bindings, the placements it appears in (record, row, or toolbar), its optional visibility formula and its confirmation prompt. Requires the `databases:read` permission.