Database endpoints
Delete a row
Deletes one row by primary key outside a transaction; deleting a missing row succeeds with deleted set to false.
DELETE /v1/tenants/{tenant}/rows/{schema}/{pk}
- Select the table and keyIdentify the exact row to remove.
- Request row deletionDelete outside a transaction.
- Check the deleted flagDistinguish a removed row from an already absent one.
Before you start
Use your database bearer token.
Use the intended table and primary key. The example deletes u1 from demo.people.
Path parameters
| Field | Type | Required |
|---|---|---|
tenant | string | Required |
schema | string | Required |
pk | string | Required |
Headers
| Field | Type | Required | Description |
|---|---|---|---|
x-oc-db-user | string | Optional | Acting database user (role, grant and row-policy checks). Send with x-oc-db-key. |
x-oc-db-key | string | Optional | API key of the x-oc-db-user user. |
Read the result
deleted: true means a row was removed. deleted: false is a successful request for a key that was already absent, so do not count every successful response as one deleted row.
Response statuses
HTTP status reference
| Status | What to do |
|---|---|
| 200 | OK |
| 400 | Correct the request before retrying. |
| 401 | Check the credential and Authorization header. |
| 402 | Check feature access or available credits. |
| 403 | Check tenant access, roles and permissions. |
| 404 | Check the resource ID and API route. |
| 409 | Resolve the conflict before retrying. |
| 413 | Split or reduce the request body. |
| 429 | Honor Retry-After when present; back off. |
| 500 | Check the outcome before retrying a write. |
| 501 | Check deployment support for this operation. |
| 503 | Honor Retry-After when present; check write outcomes. |