Skip to navigation
Modbox APIsandboxes

List every sandbox in a realm (admin)

View as Markdown

Administrative view across all users in a Keycloak realm. Requires the tenant_admin role — regular callers should use GET /sandboxes instead.

Authentication

AuthorizationBearer

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

Path parameters

realmstringRequired

Query parameters

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