Connections

Target-owned logical connection bindings, tests, refreshes, and redacted health.

Operations

Each operation lists its specific responses. See Common error responses for errors shared by every operation on this page.

List target connection bindings

GET /api/v1/workspaces/{workspace}/targets/{target}/environments/{environment}/connection-bindings

Operation ID: listTargetConnectionBindings
Effect: read
Confirmation: never
Required privilege: MANAGE_CONNECTION_METADATA
Focused reference: JSON · Markdown

Parameters

Responses

Create a target connection binding

POST /api/v1/workspaces/{workspace}/targets/{target}/environments/{environment}/connection-bindings

Operation ID: createTargetConnectionBinding
Effect: write
Confirmation: conditional
Required privilege: MANAGE_CONNECTION_METADATA
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

Get target connection binding metadata

GET /api/v1/workspaces/{workspace}/targets/{target}/environments/{environment}/connection-bindings/{connection}

Operation ID: getTargetConnectionBinding
Effect: read
Confirmation: never
Required privilege: MANAGE_CONNECTION_METADATA
Focused reference: JSON · Markdown

Parameters

Responses

Update target connection binding metadata

PUT /api/v1/workspaces/{workspace}/targets/{target}/environments/{environment}/connection-bindings/{connection}

Operation ID: updateTargetConnectionBinding
Effect: idempotent-write
Confirmation: conditional
Required privilege: MANAGE_CONNECTION_METADATA
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

Disable a target connection binding

POST /api/v1/workspaces/{workspace}/targets/{target}/environments/{environment}/connection-bindings/{connection}/disable

Operation ID: disableTargetConnectionBinding
Effect: write
Confirmation: conditional
Required privilege: MANAGE_CONNECTION_METADATA
Focused reference: JSON · Markdown

Parameters

Responses

Enable a target connection binding

POST /api/v1/workspaces/{workspace}/targets/{target}/environments/{environment}/connection-bindings/{connection}/enable

Operation ID: enableTargetConnectionBinding
Effect: write
Confirmation: conditional
Required privilege: MANAGE_CONNECTION_METADATA
Focused reference: JSON · Markdown

Parameters

Responses

Get redacted target connection runtime health

GET /api/v1/workspaces/{workspace}/targets/{target}/environments/{environment}/connection-bindings/{connection}/health

Operation ID: getTargetConnectionBindingHealth
Effect: read
Confirmation: never
Required privilege: VIEW_CONNECTION_HEALTH
Focused reference: JSON · Markdown

Parameters

Responses

Plan a dependency-aware target connection change

POST /api/v1/workspaces/{workspace}/targets/{target}/environments/{environment}/connection-bindings/{connection}/plan

Operation ID: planTargetConnectionBindingChange
Effect: write
Confirmation: conditional
Required privilege: MANAGE_CONNECTION_METADATA
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

Refresh credentials and replace the validated target pool

POST /api/v1/workspaces/{workspace}/targets/{target}/environments/{environment}/connection-bindings/{connection}/refresh

Operation ID: refreshTargetConnectionBinding
Effect: write
Confirmation: conditional
Required privilege: TEST_CONNECTION
Focused reference: JSON · Markdown

Parameters

Responses

Test a target connection through the candidate runtime path

POST /api/v1/workspaces/{workspace}/targets/{target}/environments/{environment}/connection-bindings/{connection}/test

Operation ID: testTargetConnectionBinding
Effect: write
Confirmation: conditional
Required privilege: TEST_CONNECTION
Focused reference: JSON · Markdown

Parameters

Responses

Common error responses

These error responses apply to every operation on this page.