Skip to main content
POST
Create Image Prewarm Task

Headers

Content-Type
string
required

Allowed value: application/json.

Authorization
string
required

Bearer authentication format, e.g.: Bearer {{API_KEY}}.

Body

application/json
image
string
required

Fully qualified image to prewarm. String, length: 1-4095 characters.

Example:

"registry.example.com/team/image:tag"

region_id
string
required

Target region ID. String, length: 1-255 characters.

Example:

"region-a"

registry_auth_id
string

Registry authentication ID. Required when prewarming a private image. String, length: 0-255 characters.

Example:

"registry-auth-id"

product_ids
string[]

Product IDs to cover with prewarming.

Example:
note
string

Note for the prewarm task.

Example:

""

Response

200 - application/json

OK

task_id
string

Image prewarm task ID

Example:

"prewarm-task-id"

Last modified on June 23, 2026