Delete all schemas

DELETE /v1/tenants/{tenant}/schemas

Remove every table in one tenantEvery selected tenant table and its data is irreversibly purged.

Verify the tenant scopeConfirm the operation covers all of its tables.
Delete all table schemasRemove their rows, indexes and related data.
Inspect the removed IDsReview deleted table and row counts.

Before you start

Use your database bearer token.

This operation targets every table in the tenant. Check the tenant before sending it.

Path parameters

Field	Type	Required
`tenant`	`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

deleted and ids report the removed tables, with rows_deleted for their data. This applies to every table in the selected tenant and is irreversible.

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.
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" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "complete": true,
  "deleted": 1,
  "ids": [
    "demo.people"
  ],
  "irreversible": true,
  "rows_deleted": 3
}

Destructive purge example; key and row counts depend on the database.

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