Skip to main content
GET
Get Operation Endpoint
Some Ardent work takes longer than a single request: connector discovery, connector setup, resets, and environment operations. Those endpoints return an operation ID that you can poll. Add ?wait=10 to long-poll: the server holds the request up to that many seconds (max 10) and answers early if the operation finishes. This cuts most polling loops to a single line. Add ?wait=10 to long-poll: the server holds the request up to that many seconds (max 10) and answers early if the operation finishes. This cuts most polling loops to a single line. Representative response:
stage is a machine token; stage_label is the human-readable version for progress displays.

Status values

Results

When an operation completes, result holds the outcome. For branch_create operations, result contains the full branch details, including branch_url — that’s where automation picks up the connection string. See Branches for the shape.

Polling loop

Poll with a bounded timeout in production automation. If an operation fails, read error, fix the cause, and start a new supported action rather than assuming the old operation will recover.

Authorizations

Authorization
string
header
required

Ardent API key (sk-ard_live_… / sk-ard_test_…) or a dashboard session token.

Path Parameters

operation_id
string
required

Query Parameters

wait
number | null

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

Required range: 0 <= x <= 10

Response

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

created_at
string
required

When the operation was created.

id
string
required

Operation ID.

org_id
string
required

Organization the operation belongs to.

resource_id
string | null
required

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

status
enum<string>
required

Current status. completed and failed are terminal.

Available options:
pending,
running,
completed,
failed
type
enum<string>
required

The kind of work this operation tracks, for example branch_create.

Available options:
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
updated_at
string
required

When the operation was last updated.

completed_at
string | null

When the operation finished. Null until then.

error
string | null

Error message when the operation failed.

progress
integer | null

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

Required range: 0 <= x <= 100
result
Result · object | null

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

setup_status
Setup Status · object | null

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

stage
string | null

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

stage_label
string | null

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

started_at
string | null

When work started. Null until then.