Container Registries

Create a container registry

Configure a container registry for pulling images into a project's sandboxes. Requires project admin (registries hold push/pull credentials).

The full image path is built as endpoint/namespace/image:tag. For example:

RegistryendpointnamespaceFull image path
Docker Hubdocker.iomyuserdocker.io/myuser/image:tag
GitHub CRghcr.iomy-orgghcr.io/my-org/image:tag
Google ARus-docker.pkg.devproject/repous-docker.pkg.dev/project/repo/image:tag
AWS ECR123456.dkr.ecr.us-east-1.amazonaws.com(empty)123456.dkr.ecr.../image:tag

All registries require authentication. Choose personal_access_token (default) for GitHub/GitLab, basic for username/password registries, or bearer for token-only registries.

A project can have at most 1000 container registries. A create beyond that answers 422.

POST
/v1/orgs/{org}/projects/{project}/registries
AuthorizationBearer <token>

API key starting with tektona_. Create one at app-dev.tektona.ai under API Keys.

In: header

Path Parameters

org*string

Organization name

Match^[a-z0-9][a-z0-9-]*[a-z0-9]$
Length2 <= length <= 64
project*string

Project name

Match^[a-z0-9][a-z0-9-]*[a-z0-9]$
Length2 <= length <= 64

Query Parameters

dry_run?boolean

Test connection without saving

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

auth_type*string

Authentication type

Default"personal_access_token"

Value in

  • "basic"
  • "personal_access_token"
  • "bearer"
display_name*string

Human-readable registry name

Match^[^\x00-\x08\x0a-\x1f\x7f-\x9f‪-‮⁦-⁩]*$
Length1 <= length <= 100
endpoint*string

Registry host with an optional port, for example ghcr.io or registry.example.com:5000. A leading https:// is allowed. A path, a user name, a query and any other scheme are refused.

Match^(?:https://)?(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?(?:\.[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?)*|\[[0-9A-Fa-f]*:[0-9A-Fa-f:.]*\])(?::(?:[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))?$
Length1 <= length <= 255
name*string

URL-safe registry identifier

Match^[a-z0-9][a-z0-9-]*[a-z0-9]$
Length2 <= length <= 64
namespace?string

Repository path prefix within the registry, for example my-org or my-org/team-a. Each part is lowercase letters and digits, which a dot, an underscore or a hyphen can separate.

Match^(?:[a-z0-9]+(?:(?:\.|_|__|-+)[a-z0-9]+)*(?:/[a-z0-9]+(?:(?:\.|_|__|-+)[a-z0-9]+)*)*)?$
Lengthlength <= 255
password?string

Password (required for basic)

Lengthlength <= 255
token?string

Token (required for personal_access_token and bearer)

Lengthlength <= 4096
username?string

Username (required for basic and personal_access_token)

Lengthlength <= 255

Response Body

application/json

application/problem+json

curl -X POST "https://example.com/v1/orgs/string/projects/string/registries" \  -H "Content-Type: application/json" \  -d '{    "auth_type": "basic",    "display_name": "string",    "endpoint": "string",    "name": "string"  }'
{  "auth_type": "basic",  "created_at": "string",  "display_name": "My GitHub Registry",  "endpoint": "ghcr.io",  "has_credentials": true,  "id": "string",  "name": "my-ghcr",  "namespace": "my-org",  "owner": {    "project": {      "display_name": "string",      "name": "string"    },    "type": "project"  },  "updated_at": "string"}