Skip to main content
POST
Connect an image registry

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"

Query Parameters

upstream_id
string
required

a lowercase resource id (AIP-122)

Body

application/json
host
string
required

Public HTTPS OCI registry DNS hostname, optionally with a port. No scheme, IP literal, userinfo, private suffix or Akua-served hostname.

Maximum string length: 259
path
string
required
Maximum string length: 255
username
string
required
Required string length: 1 - 255
secret
string
required
test_image
string
Maximum string length: 1024
skip_test
boolean

Response

Upstream created

upstream_id
string
required

a lowercase resource id (AIP-122)

workspace_id
string
required
Required string length: 2 - 53
host
string
required

Public HTTPS OCI registry DNS hostname, optionally with a port. No scheme, IP literal, userinfo, private suffix or Akua-served hostname.

Maximum string length: 259
path
string
required
Maximum string length: 255
username
string
required
Required string length: 1 - 255
secret
string
required
image_prefix
string
required
test_image
string | null
required
created_at
number
required
etag
string
required