Sign in

v2

latestOpenAPI 3.1.02026-07-2675166192.8 KB
Images

Initiate Image Build

Initiate an image build process.

Returns a presigned URL to upload the build context (tar.gz file). After uploading, call /images/build/{build_id}/start to begin the build.

post/api/v1/images/build

Request body

image_namestring nullable

Image name (e.g., 'myapp'). Required for build-context builds; optional for transfers.

image_tagstring nullable

Image tag (e.g., 'v1.0.0'). Required for build-context builds; optional for transfers.

dockerfile_pathstring

Path to Dockerfile within build context

sourceImagestring nullable

Existing public image reference, or comma-separated image references, to transfer instead of uploading a build context

platform'linux/amd64' | 'linux/arm64'

Target platform (linux/amd64 or linux/arm64)

teamIdstring nullable

Team ID if building image in team context

visibility'INHERIT' | 'PRIVATE' | 'PUBLIC'
ownerScope'platform' nullable

Set to 'platform' to build an org-less platform image. Public Docker Hub source transfers are promoted to platform scope automatically; other platform builds remain admin-only. Platform images are PUBLIC and cannot set teamId.

Response

Successful Response

OR