Delete a schema

Deletes one table and irreversibly purges all of its rows, indexes and related data.

DELETE /v1/tenants/{tenant}/schemas/{id}

Remove a table and all its dataThis operation is irreversible, not just removal of a schema description.

Verify the table IDCheck the precise table targeted for removal.
Delete the tablePurge its rows, indexes and related data.
Inspect the removal totalsReview reported deleted rows and keys.

Before you start

Use your database bearer token.

Connection setup

Check the table ID and the purge_rows option before deleting data. The example targets demo.people.

Path parameters

Field	Type	Required
`tenant`	`string`	Required
`id`	`string`	Required

Query parameters

Field	Type	Required
`purge_rows`	`boolean`	Optional

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

The result reports removed rows and keys and marks the operation irreversible. This deletes the table's data and indexes, not just its schema definition.

Response statuses

HTTP status reference

Status	What to do
200	OK
204	No content
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.
429	Honor Retry-After when present; back off.
500	Check the outcome before retrying a write.
501	Check deployment support for this operation.
502	Check service availability and the write outcome.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request DELETE "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/schemas/demo.people" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "schema": "demo.people",
  "rows_deleted": 3,
  "keys_removed": 12,
  "irreversible": true
}

200 illustrates purge_rows=true; the default request can return 204 on an empty table or 409 on a protected non-empty table.

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

Query parametersCopy Anchor Link

HeadersCopy Anchor Link