Skip to main content

Pull

Pull a container image on the target node:

$ osapi client container docker pull --image nginx:latest

Job ID: 550e8400-e29b-41d4-a716-446655440000

Hostname: server1
Image ID: sha256:a1b2c3d4...
Tag: latest
Size: 187.8 MiB

Pull a specific image version:

$ osapi client container docker pull --image alpine:3.18

Pull from a custom registry:

$ osapi client container docker pull \
--image registry.example.com/myapp:v1.2.3

Target a specific host:

$ osapi client container docker pull --image redis:7 --target web-01

Pull on all hosts:

$ osapi client container docker pull --image nginx:latest --target _all

JSON Output

Use --json to get the full API response:

$ osapi client container docker pull --image nginx:latest --json

Flags

FlagDescriptionDefault
--imageImage reference to pull (required)
-T, --targetTarget: _any, _all, hostname, or label (group:web)_any
-j, --jsonOutput raw JSON response