Set registry auth

Stores or replaces the credentials used when this server talks to the registry. The method must match the registry’s well-known auth advertisement: a mismatch or an unsupported method fails with 400 and nothing is stored. Credentials are encrypted at rest with AES-256-GCM. For oauth2, a client-credentials token is exchanged immediately; transport policy refusals (non-https token endpoint outside the loopback/insecure-CIDR allowlist) fail with 400, while exchange failures store the credentials and report error status.

POST /registries/{id}/auth

Set registry auth

cURL

curl --request POST \
  --url http://localhost:9371/registries/{id}/auth \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "apiKey",
  "apiKey": "<string>"
}
'

200

{
  "auth": {
    "type": "apiKey",
    "status": "configured",
    "headerName": "<string>",
    "tokenExpiresAt": 123,
    "message": "<string>"
  }
}

Path Parameters

id · string · required

Registry slug identifying the registry.

Minimum string length: 1

Body

application/json

Option 1

Option 2

Credentials used when the server talks to the registry. The token endpoint (oauth2) and header name (apiKey) always come from the registry's well-known advertisement, never from this request.

type · enum<string> · required

API key authentication; the key is sent in a fixed header.

Available options: apiKey

apiKey · string · required

API key sent in the header named by the registry's well-known auth advertisement.

Minimum string length: 1

Response

200

application/json

The credentials were stored.

Response body of a registry auth setup request.

auth · object · required

Outcome of storing credentials for a registry.

Show child attributes