Skip to main content
Read image preparation status

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Query Parameters

image
string
required

Image reference, repo@sha256:digest, or a Dockerfile preparation's returned sha256:<64 lowercase hex> selector. Content selectors read only this workspace's recorded copies without contacting a registry. A private tag works when this workspace has prepared or created it with registry_credentials before; otherwise name its digest.

Minimum string length: 1
providers
string[]

Limit the status to these providers; omitted returns all recorded providers.

Minimum array length: 1
Minimum string length: 1

Response

Current preparation state for the workspace's recorded provider copies.

image
string
required

Resolved OCI reference or the canonical sha256 content selector of a Dockerfile source and context.

providers
object[]
required