Skip to navigation
Modbox APIsandboxes

List your sandboxes

View as Markdown

Returns every sandbox created by the authenticated user, newest first. Scope the result to one workspace with the X-Workspace-Id header, and filter by lifecycle state with status.

Destroyed sandboxes are retained for auditing — pass status=running to list only the usable ones.

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

realmstring or nullOptional

Filter by Keycloak realm. Rarely needed — omit it.

statusenum or nullOptional
Filter by lifecycle state.
Allowed values:

Response

Successful Response
sandboxeslist of objects
totalinteger

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error