Sign in
External Images

Register an external Docker image

Registers an external Docker image reference without triggering a deployment. The image can be deployed later using the deploy/image endpoint.

post/projects/{project_id}/external-images

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/projects/{project_id}/external-images
  • Auth: HTTP bearer

Path parameters

project_idinteger required

Request body

digeststring nullable

Image digest (sha256:...)

image_refstring required

Docker image reference (e.g., "ghcr.io/org/app:v1.0")

metadataunknown
tagstring nullable

Image tag

Example request

{
  "digest": "sha256:abc123def456",
  "image_ref": "ghcr.io/myorg/myapp:v1.0",
  "tag": "v1.0"
}

Response

Image registered successfully

created_atstring date-time required
digeststring nullable
idinteger required
image_refstring required
metadataunknown
project_idinteger required
pushed_atstring date-time required
size_bytesinteger nullable
tagstring nullable

Example response

{
  "created_at": "2025-10-12T12:15:47.609192Z",
  "pushed_at": "2025-10-12T12:15:47.609192Z"
}

Changes

No recorded changes to this operation across all 50 revisions of this API.