Remotehost Docs
API ReferenceSandboxes

Status of a sandbox's environment services

GET
/sandboxes/{sandboxId}/services

The services its environment declares, as this boot started them (where services are enabled; rolling out, and empty until then): after the setup script on a create or a cold boot, as the sandbox user, from /code or the service's cwd. A resume from memory keeps them running. A service that exits is not restarted. Empty when none were started this boot. The sandbox must be running or ready.

Authorization

bearerAuth
AuthorizationBearer <token>

A RemoteHost API key (rh_sk_...) or a user session token.

In: header

Path Parameters

sandboxId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sandboxes/string/services"
{  "services": [    {      "name": "string",      "port": 0,      "state": "running",      "exitCode": 0,      "listening": true,      "logPath": "string"    }  ]}

Retrieve a sandbox GET

Poll this to follow provisioning and lifecycle changes. The platform does not send lifecycle webhooks.

List a project's workspaces GET

Most recently active first. Deleted workspaces are not listed. With an API key, only the workspaces its principal owns (the person who minted it, or its service account). API keys reach these operations only where key access to environments is enabled for this deployment, and then only their principal's own workspaces; until then every API key is refused with 403.