Authenticate to Katapult Container Registry

To access and manage container images in the Katapult Container Registry, you’ll need to authenticate using an API token. Follow the steps below to generate a token and use it with your container tools.

Get an API token

1. Log in to your Katapult account.
2. Navigate to the API Tokens section in Access and select Add new API token.
3. Give your token a name.
4. (Optional) Add Authorised IP Addresses to restrict where the token can be used.
5. Select the required scopes:
   • For full access: Core: Manage container registries
   • For read-only access: Core: Read-only access to container registries
6. Click Create API token.
7. Copy the token and store it securely. You won't be able to view it again.

Use the API token

Use this token as your password when authenticating with the Katapult Container Registry via Docker or other compatible tools.

Docker

docker login kcr.io \
    --username <your-katapult-email> \
    --password <your-api-token>

You can also log in interactively by running docker login kcr.io and entering your email and API token when prompted.

Buildah

buildah login kcr.io \
    --username <your-katapult-email> \
    --password <your-api-token>

You can also log in interactively by running buildah login kcr.io and entering your email and API token when prompted.

Helm

helm registry login kcr.io \
    --username <your-katapult-email> \
    --password <your-api-token>

You can also log in interactively by running helm login kcr.io and entering your email and API token when prompted.

Podman

podman login kcr.io \
    --username <your-katapult-email> \
    --password <your-api-token>

You can also log in interactively by running podman login kcr.io and entering your email and API token when prompted.

Skopeo

skopeo login kcr.io \
    --username <your-katapult-email> \
    --password <your-api-token>

You can also log in interactively by running skopeo login kcr.io and entering your email and API token when prompted.