For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Home Guides API Reference

Skip to navigation

Modbox API system

Liveness probe

||View as Markdown|

GET

///health

GET

/health

curl /health

200Retrieved

Returns 200 while the service is accepting traffic. Requires no authentication — safe to use for uptime monitoring.

Response

Successful Response

Was this page helpful?

Remove a workspace member

Provision a sandbox

Home Guides API Reference

Overview
- API Overview
Modbox API

API Overview
List your workspaces
Create a workspace
Get a workspace
Update a workspace
Delete a workspace
List workspace members
Add a workspace member
Change a member's role
Remove a workspace member
Liveness probe
Provision a sandbox
Destroy a sandbox
Check whether a sandbox is ready
Block until a sandbox is ready
Get a sandbox
List your sandboxes
List every sandbox in a realm (admin)
Read sandbox logs and metrics
List sandbox images
Register a sandbox image
Get a sandbox image
Update a sandbox image
Delete a sandbox image
List registry credentials
Create a registry credential
Get a registry credential
Update a registry credential
Delete a registry credential