Skip to navigation
Modbox APIimages

Get a sandbox image

View as Markdown

Returns one image definition, including its memory allocation, readiness port and default TTL.

Authentication

AuthorizationBearer

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

Path parameters

image_idstringRequiredformat: "uuid"

Headers

x-workspace-idstring or nullOptional

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

Response

Successful Response
idstringformat: "uuid"
namestring
imagestring
descriptionstring or null
tagstring
enabledboolean
is_defaultboolean
memory_mbinteger
created_atdatetime
updated_atdatetime
readiness_portinteger or nullOptional
ttl_secondsinteger or nullOptional
workspace_idstring or nullOptionalformat: "uuid"
registry_idstring or nullOptionalformat: "uuid"
registry_namestring or nullOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error