Sign in
Docker

Pull Image

Start downloading a Docker image in the background.

Initiates an asynchronous pull operation for the specified Docker image. The pull runs in the background, allowing the API to remain responsive. Use the /pull-status endpoint to monitor progress.

Use this endpoint to download new Hummingbot versions or other required images before creating containers.

post/docker/pull-image

Request body

image_namestring required

Full Docker image name with optional tag. Format: 'repository/image:tag'. Examples: 'hummingbot/hummingbot:latest', 'hummingbot/hummingbot:1.28.0', 'hummingbot/gateway:latest'. If no tag is specified, 'latest' is assumed.

Response

Successful Response

{"stackTrail":"paths:/docker/pull-image:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes