images

Store credentials for pulling private images from a registry.

Replaces any credentials stored for the same registry. The secret is sealed to Runtime's hosts the moment it arrives: the API can never read it back and no call returns it. A build opens it only to pull, inside its own build guest. For Amazon ECR, give an access key that may call ecr:GetAuthorizationToken and pull; each build asks ECR for a fresh token.

post/v1/images/registries

Request

  • Base URL: https://api.withruntime.com
  • URL: https://api.withruntime.com/v1/images/registries
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Replaying the same key with the same request within 24 hours returns the first result and never repeats the effect. A refusal is not kept: a request refused before it ran (no_capacity, busy, a limit) runs afresh when sent again with its key. The SDKs send one automatically; the server makes one when absent and returns it in the idempotency-key response header.

Request body

registrystring required

The registry host: docker.io, ghcr.io, gcr.io, us-docker.pkg.dev, 123456789012.dkr.ecr.us-east-1.amazonaws.com, or any other.

usernamestring

Docker Hub or GitHub user, oauth2accesstoken or _json_key for Google.

passwordstring

A token or password; for _json_key, the service account's JSON key.

accessKeyIdstring

Amazon ECR: an AWS access key id.

secretAccessKeystring

Amazon ECR: its secret.

Response

Success

idstring required
registrystring required
kind'basic' | 'ecr' required
usernamestring required
regionstring nullable
createdAtstring

Changes

No recorded changes to this operation across all 1 revision of this API.