Commit a transaction

Atomically commits every write buffered in the transaction, enforcing foreign-key, check and unique constraints.

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

Make buffered transaction writes durable togetherA lost commit response requires checking the outcome before repeating work.

Identify the open transactionUse the ID holding your buffered writes.
Commit and check constraintsApply the writes atomically when validation succeeds.
Read committed and log positionConfirm the result before treating writes as complete.

Before you start

Use your database bearer token.

Connection setup

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.

committed: true confirms the transaction's buffered writes were committed. lsn identifies the returned log position. A timeout does not establish failure; check the outcome before repeating a commit or its writes.

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.
500	Check the outcome before retrying a write.
501	Check deployment support for this operation.
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/commit" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "committed": true,
  "tx_id": "11111111-1111-4111-8111-111111111111",
  "lsn": {
    "segment": 1,
    "offset": 1042
  },
  "_preview": true
}

Illustrates a WAL-backed commit; lsn can be null on multi-writer databases.

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