Skip to navigation
Modbox APIimages

Update a sandbox image

View as Markdown

Partially updates an image — only the fields you send are changed.

Global default images are read-only; copy one with POST /sandbox-images to customise it.

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.

Request

This endpoint expects an object.
namestring or nullOptional1-255 characters
imagestring or nullOptional1-512 characters
descriptionstring or nullOptional<=1000 characters
tagstring or nullOptional1-128 characters
enabledboolean or nullOptional
is_defaultboolean or nullOptional
registry_idstring or nullOptionalformat: "uuid"
memory_mbinteger or nullOptional256-8192

Memory in MB (256–8192).

readiness_portinteger or nullOptional1-65535

HTTP port polled for readiness. Leave unset to use the exec probe (pgrep supervisord).

ttl_secondsinteger or nullOptional60-86400

Default lifetime for sandboxes using this image (60–86400).

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

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error