Skip to main content

Commit Transaction

Required role: write or higher.

Commit the current transaction.

Path Parameters
pipeline_name string — REQUIRED

Unique pipeline name

Query Parameters
transaction_id int64

The ID of the transaction to commit, which /start_transaction returned:

  • If this is the transaction that the API started and that is still open, the request commits it.
  • If this is the last transaction that /commit_transaction committed, the request succeeds and does nothing, so it is safe to retry.
  • Otherwise, the request fails with 409 Conflict, for example if no transaction with this ID has started yet.

Without this parameter, the request commits the transaction that the API started.

incarnation_uuid uuid

The incarnation_uuid that /start_transaction returned. If the pipeline restarted since then, the request fails with 400 Bad Request and error code IncarnationUuidMismatch, because transaction IDs start again after a restart.

Responses
200

Commit operation initiated.

400

The given incarnation_uuid does not match the pipeline's current incarnation (error code IncarnationUuidMismatch): the pipeline process has restarted since the transaction started

Schema — OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

409

Another transaction is already in progress, or transaction_id is not the transaction that the API started.

Schema — OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

500
Schema — OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

503
Schema — OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.