Connections
Target-owned logical connection bindings, explicit credential 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/projects/{project}/targets/{target}/connection-bindings
Operation ID: listTargetConnectionBindings
Effect: read
Confirmation: never
Required privilege: RESOURCE_MANAGE
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
target |
path | Yes | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Create a target connection binding
POST /api/v1/projects/{project}/targets/{target}/connection-bindings
Operation ID: createTargetConnectionBinding
Effect: write
Confirmation: conditional
Required privilege: RESOURCE_MANAGE
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
target |
path | Yes | string | |
Idempotency-Key |
header | Yes | string |
Request body
Content types: application/json.
Responses
| Status | Description |
|---|---|
201 |
The request has succeeded and a new resource has been created as a result. |
Get target connection binding metadata
GET /api/v1/projects/{project}/targets/{target}/connection-bindings/{connection}
Operation ID: getTargetConnectionBinding
Effect: read
Confirmation: never
Required privilege: RESOURCE_MANAGE
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
target |
path | Yes | string | |
connection |
path | Yes | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Update target connection binding metadata
PUT /api/v1/projects/{project}/targets/{target}/connection-bindings/{connection}
Operation ID: updateTargetConnectionBinding
Effect: idempotent-write
Confirmation: conditional
Required privilege: RESOURCE_MANAGE
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
target |
path | Yes | string | |
connection |
path | Yes | string |
Request body
Content types: application/json.
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Disable a target connection binding
POST /api/v1/projects/{project}/targets/{target}/connection-bindings/{connection}/disable
Operation ID: disableTargetConnectionBinding
Effect: write
Confirmation: conditional
Required privilege: RESOURCE_MANAGE
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
target |
path | Yes | string | |
connection |
path | Yes | string | |
Idempotency-Key |
header | Yes | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Enable a target connection binding
POST /api/v1/projects/{project}/targets/{target}/connection-bindings/{connection}/enable
Operation ID: enableTargetConnectionBinding
Effect: write
Confirmation: conditional
Required privilege: RESOURCE_MANAGE
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
target |
path | Yes | string | |
connection |
path | Yes | string | |
Idempotency-Key |
header | Yes | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Get redacted target connection runtime health
GET /api/v1/projects/{project}/targets/{target}/connection-bindings/{connection}/health
Operation ID: getTargetConnectionBindingHealth
Effect: read
Confirmation: never
Required privilege: RESOURCE_READ
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
target |
path | Yes | string | |
connection |
path | Yes | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Plan a dependency-aware target connection change
POST /api/v1/projects/{project}/targets/{target}/connection-bindings/{connection}/plan
Query classification: computes dependencies and a confirmation token without mutating durable binding or runtime state.
Operation ID: planTargetConnectionBindingChange
Effect: write
Confirmation: conditional
Required privilege: RESOURCE_MANAGE
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
target |
path | Yes | string | |
connection |
path | Yes | string |
Request body
Content types: application/json.
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Refresh credentials and replace the validated target pool
POST /api/v1/projects/{project}/targets/{target}/connection-bindings/{connection}/refresh
Operation ID: refreshTargetConnectionBinding
Effect: write
Confirmation: conditional
Required privilege: RESOURCE_MANAGE
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
target |
path | Yes | string | |
connection |
path | Yes | string | |
Idempotency-Key |
header | Yes | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Read the local runtime's retained development profile application
GET /api/v1/projects/{project}/targets/{target}/development-profile-application
Operation ID: getDevelopmentProfileApplication
Effect: read
Confirmation: never
Required privilege: RESOURCE_MANAGE
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
target |
path | Yes | string |
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Apply an exact development profile to the local runtime
POST /api/v1/projects/{project}/targets/{target}/development-profile-application
Operation ID: applyDevelopmentProfile
Effect: write
Confirmation: conditional
Required privilege: RESOURCE_MANAGE
Focused reference: JSON · Markdown
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
project |
path | Yes | string | |
target |
path | Yes | string | |
Idempotency-Key |
header | Yes | string |
Request body
Content types: application/json.
Responses
| Status | Description |
|---|---|
200 |
The request has succeeded. |
Common error responses
These error responses apply to every operation on this page.
| Status | Description |
|---|---|
400 |
The server could not understand the request due to invalid syntax. |
401 |
Access is unauthorized. |
403 |
Access is forbidden. |
404 |
The server cannot find the requested resource. |
409 |
The request conflicts with the current state of the server. |
412 |
Precondition failed. |
413 |
Client error |
415 |
Client error |
422 |
Client error |
429 |
Client error |
500 |
Server error |
502 |
Server error |
503 |
Service unavailable. |