Sign in

v1

latestOpenAPI 3.1.02026-08-0413468163.9 KB
v1-branching

Create Service Branch

CLI endpoint to create a new branch for a connector.

post/v1/branch/create

Headers

X-Idempotency-Keystring

Makes retries safe: re-sending the same connector, service type, and name resumes the original request instead of creating a duplicate.

Request body

connector_idstring required

Connector to branch from.

service_typestring required

Service to branch; postgres, not the connector type postgresql.

namestring required

Branch name, unique per connector.

Response

Create accepted. Poll GET /v1/operations/{operation_id} for the branch details. Idempotent replays carry an X-Idempotency-Replay: true response header.

operation_idstring required

Operation to poll at GET /v1/operations/{operation_id}.

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

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

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 being created or acted on (the branch ID for branch create).