Create Sandbox Image | Modbox

Create a new sandbox image. Requires authentication.

AuthorizationBearer

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

This endpoint expects an object.

imagestringRequired1-512 characters

namestringRequired1-255 characters

descriptionstring or nullOptional<=1000 characters

enabledbooleanOptionalDefaults to true

is_defaultbooleanOptionalDefaults to false

memory_mbintegerOptional256-8192Defaults to 1024

Memory in MB (256–8192)

readiness_portinteger or nullOptional1-65535

HTTP port for readiness probe. Leave blank to use exec probe (pgrep supervisord).

registry_idstring or nullOptionalformat: "uuid"

tagstringOptional1-128 charactersDefaults to latest

ttl_secondsinteger or nullOptional60-86400

Hard time limit in seconds for sandbox pods (60–86400). Leave blank for no limit.

Successful Response

created_atdatetime

descriptionstring or null

enabledboolean

idstringformat: "uuid"

imagestring

is_defaultboolean

memory_mbinteger

namestring

tagstring

updated_atdatetime

readiness_portinteger or null

registry_idstring or nullformat: "uuid"

registry_namestring or null

ttl_secondsinteger or null

workspace_idstring or nullformat: "uuid"

422

Unprocessable Entity Error

$	curl -X POST https://api.modbox.run/sandbox-images \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"image": "string",
>	"name": "string"
>	}'