Sign in

v1

latestOpenAPI 3.1.02026-08-0413468163.9 KB
v1-operations

Get Operation Endpoint

Return the current state of an async operation.

Polled or long-polled by clients to drive operation progress. RLS scopes visibility to operations whose resource (connector) the caller can read; an operation belonging to another tenant looks like a 404 to a non-member rather than leaking existence.

Returns the AsyncOperationResponse shape — see models.py.

get/v1/operations/{operation_id}

Path parameters

operation_idstring required

Query parameters

waitnumber nullable

Optionally wait up to this many seconds for a terminal operation state. Omit for the existing immediate poll response.

Optionally wait up to this many seconds for a terminal operation state. Omit for the existing immediate poll response.

Response

Current operation state. On completed, result holds the outcome — for branch_create, the full branch details.

idstring required

Operation ID.

org_idstring required

Organization the operation belongs to.

type'connector_engine_setup' | 'connector_reset' | 'connector_deep_reset' | 'connector_discovery' | 'connector_delete' | 'connector_secret_purge' | 'connector_rollout' | 'connector_replication_rollback' | 'connector_debezium_cutover' | 'connector_debezium_shadow_cleanup' | 'environment_deploy' | 'environment_destroy' | 'branch_create' | 'branch_delete' required

Discriminator for an async operation. Must match the async_operations_type_valid CHECK constraint in the migration — extending the set requires a migration to widen the constraint AND a worker registered in the dispatcher.

resource_idstring nullable required

ID of the resource the operation acts on (the branch ID for branch create).

status'pending' | 'running' | 'completed' | 'failed' required

Lifecycle status of an async operation. Mirrors the async_operations_status_valid CHECK constraint.

stagestring nullable

Raw progress token, kept for released CLIs. Read stage_label instead.

stage_labelstring nullable

Human-readable stage; null means the operation has not started yet.

progressinteger nullable

Best-effort completion percentage. Null when no estimate is available.

setup_statusobject nullable

Connector setup progress detail. Present only for connector engine setup.

resultobject nullable

Result payload on completion; for branch create, includes branch_url.

errorstring nullable

Error message when the operation failed.

started_atstring nullable

When work started. Null until then.

completed_atstring nullable

When the operation finished. Null until then.

created_atstring required

When the operation was created.

updated_atstring required

When the operation was last updated.