Skip to content
Get started

Builds

List builds
get/builds
Get build details
get/builds/{id}
Cancel build
delete/builds/{id}
Stream build events (SSE)
get/builds/{id}/events
ModelsExpand Collapse
Build = object { id, created_at, status, 9 more }
id: string

Build job identifier

created_at: string

Build creation timestamp

formatdate-time
status: BuildStatus

Build job status

Accepts one of the following:
"queued"
"building"
"pushing"
"ready"
"failed"
"cancelled"
builder_instance_id: optional string

Instance ID of the builder VM (for debugging)

completed_at: optional string

Build completion timestamp

formatdate-time
duration_ms: optional number

Build duration in milliseconds

formatint64
error: optional string

Error message (only when status is failed)

image_digest: optional string

Digest of built image (only when status is ready)

image_ref: optional string

Full image reference (only when status is ready)

provenance: optional BuildProvenance { base_image_digest, buildkit_version, lockfile_hashes, 2 more }
base_image_digest: optional string

Pinned base image digest used

buildkit_version: optional string

BuildKit version used

lockfile_hashes: optional map[string]

Map of lockfile names to SHA256 hashes

source_hash: optional string

SHA256 hash of source tarball

timestamp: optional string

Build completion timestamp

formatdate-time
queue_position: optional number

Position in build queue (only when status is queued)

started_at: optional string

Build start timestamp

formatdate-time
BuildEvent = object { timestamp, type, content, status }
timestamp: string

Event timestamp

formatdate-time
type: "log" or "status" or "heartbeat"

Event type

Accepts one of the following:
"log"
"status"
"heartbeat"
content: optional string

Log line content (only for type=log)

status: optional BuildStatus

New build status (only for type=status)

Accepts one of the following:
"queued"
"building"
"pushing"
"ready"
"failed"
"cancelled"
BuildPolicy = object { cpus, memory_mb, network_mode, timeout_seconds }
cpus: optional number

Number of vCPUs for builder VM (default 2)

memory_mb: optional number

Memory limit for builder VM (default 2048)

network_mode: optional "isolated" or "egress"

Network access during build

Accepts one of the following:
"isolated"
"egress"
timeout_seconds: optional number

Maximum build duration (default 600)

BuildProvenance = object { base_image_digest, buildkit_version, lockfile_hashes, 2 more }
base_image_digest: optional string

Pinned base image digest used

buildkit_version: optional string

BuildKit version used

lockfile_hashes: optional map[string]

Map of lockfile names to SHA256 hashes

source_hash: optional string

SHA256 hash of source tarball

timestamp: optional string

Build completion timestamp

formatdate-time
BuildStatus = "queued" or "building" or "pushing" or 3 more

Build job status

Accepts one of the following:
"queued"
"building"
"pushing"
"ready"
"failed"
"cancelled"