Skip to navigation
Modbox APIimages

List sandbox images

View as Markdown

Returns the images available to the current workspace, plus the global defaults shared by every workspace.

Start here before provisioning: pass the id of the image you want as image_id to POST /sandboxes/provision. Filter with enabled_only=true to skip images that cannot be booted.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

x-workspace-idstring or nullOptional

UUID of the workspace that scopes this request. List the workspaces you belong to with GET /workspaces.

Query parameters

enabled_onlybooleanOptionalDefaults to false
Return only images that can currently be provisioned.

Response

Successful Response
imageslist of objects
totalinteger

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error