Skip to main content
POST
Create a connection grant

Authorizations

Authorization
string
header
required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

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_j572abc123def456"

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"

Body

application/json
target
object
required

One connection, or a connector's connection owned by the acting user, which Connect resolves at request time.

principal
object
required
vault_id
string

A vault id

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

"vlt_j572abc123def456"

operations
string[]
Maximum array length: 100
Maximum string length: 100
approval
enum<string>
Available options:
none,
per_action
expires_at
integer
Required range: x >= 0

Response

Connection grant created

id
string
required

A connection grant id

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

"cgr_j572abc123def456"

vault_id
string
required

A vault id

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

"vlt_j572abc123def456"

target
object
required

One connection, or a connector's connection owned by the acting user, which Connect resolves at request time.

principal
object
required
operations
string[]
required

Catalog operation ids the grant allows. Empty means every reviewed operation.

approval
enum<string>
required
Available options:
none,
per_action
expires_at
integer | null
required

Unix timestamp (seconds) after which the grant stops applying, or null.

Required range: x >= 0
state
enum<string>
required
Available options:
ACTIVE,
REVOKED
revision
integer
required
Required range: x >= 1
created_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0