Skip to main content
POST
Set a connection credential

Authorizations

Authorization
string
header
required

Bearer token for the authenticated caller.

Headers

akua-context
string

Optional workspace/scope context for the request. Carries a single workspace wire id (ws_…) today. Only needed for broad tokens - a workspace-owned token implies its workspace.

Required string length: 1 - 53
Example:

"ws_j572abc123def4"

idempotency-key
string

Optional caller-supplied idempotency key. Any non-empty key up to 64 characters is accepted. Endpoint-specific documentation describes how the key is used.

Required string length: 1 - 64
Example:

"create-prod-2026-05-07"

Path Parameters

vault
string
required

A vault id chosen by its creator, unique in the Workspace. default is the Workspace vault.

Pattern: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$
Example:

"default"

connection
string
required

A connection id

Pattern: ^conn_[^\s/]{1,64}$
Example:

"conn_j572abc123def456"

Body

application/json
fields
object
required

Response

VaultConnection

name
string
required

Resource name vaults/{vault}/connections/{connection}.

id
string
required

A connection id

Pattern: ^conn_[^\s/]{1,64}$
Example:

"conn_j572abc123def456"

connector
string
required

A connector's stable slug.

Pattern: ^[a-z0-9][a-z0-9_-]{0,63}$
Example:

"akua"

display_name
string
required
Required string length: 1 - 100
owner
object
required

Who owns the connection: the Workspace (a shared account), one user (their own account) or an end customer user in a reseller vault.

state
enum<string>
required
Available options:
PENDING_CONSENT,
CONNECTED,
REAUTH_REQUIRED,
REVOKING,
REVOKED,
ERROR
created_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
etag
string
required

Pass as If-Match on writes. OUTPUT_ONLY.

Maximum string length: 64