Roll back a transaction

POST /v1/tenants/{tenant}/tx/{tx_id}/rollback

Discard the transaction's pending changesThis does not undo writes previously sent outside this transaction.

Identify the transactionUse the ID holding the unwanted buffered writes.
Roll back the transactionDiscard the writes and close it.
Confirm rolled_backTreat the transaction as finished after confirmation.

Before you start

Use your database bearer token.

Begin a transaction and replace TX_ID with its returned tx_id. Finish the transaction with commit or rollback.

Path parameters

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

rolled_back: true confirms the transaction's buffered writes were discarded and the transaction closed. It does not undo operations previously sent outside that transaction.

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.
429	Honor Retry-After when present; back off.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request POST "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/tx/%3CTX_ID%3E/rollback" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "rolled_back": true,
  "tx_id": "11111111-1111-4111-8111-111111111111",
  "_preview": true
}

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Read the resultCopy Anchor Link

Response statusesCopy Anchor Link

Before you start

Path parameters

Headers

Read the result

Response statuses