Skip to content
Get started

Images

List images
client.Images.List(ctx) (*[]Image, error)
get/images
Pull and convert OCI image
client.Images.New(ctx, body) (*Image, error)
post/images
Get image details
client.Images.Get(ctx, name) (*Image, error)
get/images/{name}
Delete image
client.Images.Delete(ctx, name) error
delete/images/{name}
ModelsExpand Collapse
type Image struct{…}
CreatedAt Time

Creation timestamp (RFC3339)

formatdate-time
Digest string

Resolved manifest digest

Name string

Normalized OCI image reference (tag or digest)

Status ImageStatus

Build status

Accepts one of the following:
const ImageStatusPending ImageStatus = "pending"
const ImageStatusPulling ImageStatus = "pulling"
const ImageStatusConverting ImageStatus = "converting"
const ImageStatusReady ImageStatus = "ready"
const ImageStatusFailed ImageStatus = "failed"
Cmd []stringoptional

CMD from container metadata

Entrypoint []stringoptional

Entrypoint from container metadata

Env map[string, string]optional

Environment variables from container metadata

Error stringoptional

Error message if status is failed

QueuePosition int64optional

Position in build queue (null if not queued)

SizeBytes int64optional

Disk size in bytes (null until ready)

formatint64
WorkingDir stringoptional

Working directory from container metadata