Sign Up

Registries

GET
/registries

Authorization

headerAuthorizationBearer <token>

Bearer project API key.

Scope: read:registries

Query Parameters

limit?integer

Maximum number of items to return, 1–200 (default 100)

Formatint64
Range1 <= value <= 200
Default100
cursor?string

Opaque continuation token returned as next_cursor by a previous request

Response Body

The page of registry credentials

application/json
  1. response

Response for GET /registries: metadata only, never passwords.

next_cursor?|

The opaque continuation token, or null on the last page.

registries*array<>

The registry credentials in this page.

curl -X GET 'https://example.com/registries'
{  "next_cursor": "string",  "registries": [    {      "created_at": "2019-08-24T14:15:22Z",      "description": "string",      "host": "string",      "kind": "basic",      "updated_at": "2019-08-24T14:15:22Z",      "username": "string"    }  ]}
GET
/registries/{host}

Authorization

headerAuthorizationBearer <token>

Bearer project API key.

Scope: read:registries

Path Parameters

host*string

The registry host

Response Body

The registry credential metadata

application/json
  1. response

Registry credential metadata returned by list and get endpoints. Passwords are write-only and never returned.

created_at*string

When the credentials were created.

Formatdate-time
description?|

The user-facing description, or null when absent.

host*string

Normalized registry host (Docker Hub aliases collapse to index.docker.io).

kind*RegistryKind

Authentication kind. For ecr_role the username is the IAM role ARN the platform assumes.

Value in"basic""ghcr""gcr""ecr""ecr_role"
updated_at*string

When the credentials were last updated.

Formatdate-time
username*string

The registry username.

curl -X GET 'https://example.com/registries/string'
{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "host": "string",  "kind": "basic",  "updated_at": "2019-08-24T14:15:22Z",  "username": "string"}
DELETE
/registries/{host}

Authorization

headerAuthorizationBearer <token>

Bearer project API key.

Scope: delete:registries

Path Parameters

host*string

The registry host

Response Body

Registry removed

curl -X DELETE 'https://example.com/registries/string'
Empty
PUT
/registries/{host}

Passwords are encrypted at rest and are write-only.

Authorization

headerAuthorizationBearer <token>

Bearer project API key.

Scope: write:registries

Path Parameters

host*string

The registry host

Request Body

application/json
  1. body

Registry credentials. Passwords are encrypted at rest and are write-only.

description?|

An optional user-facing description.

kind?string

The authentication kind. For ecr_role, the username is the role ARN and the password is ignored.

Default"basic"
Value in"basic""ghcr""gcr""ecr""ecr_role"
password?string

Registry password/token (max 64 KiB). Write-only — never echoed back by any public read endpoint. Required for every kind but ecr_role, which ignores it.

username*string

The registry username.

Response Body

The registry credential metadata, updated

application/json
  1. response

Registry credential metadata returned by list and get endpoints. Passwords are write-only and never returned.

created_at*string

When the credentials were created.

Formatdate-time
description?|

The user-facing description, or null when absent.

host*string

Normalized registry host (Docker Hub aliases collapse to index.docker.io).

kind*RegistryKind

Authentication kind. For ecr_role the username is the IAM role ARN the platform assumes.

Value in"basic""ghcr""gcr""ecr""ecr_role"
updated_at*string

When the credentials were last updated.

Formatdate-time
username*string

The registry username.

curl -X PUT 'https://example.com/registries/string' \  -H 'Content-Type: application/json' \  -d '{  "username": "string"}'
{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "host": "string",  "kind": "basic",  "updated_at": "2019-08-24T14:15:22Z",  "username": "string"}