Remotehost Docs
API ReferenceWorkspaces

List a project's workspaces

GET
/orgs/{orgId}/projects/{projectId}/workspaces

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.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

orgId*string
projectId*string

Query Parameters

limit?integer
Range1 <= value <= 500

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/orgs/string/projects/string/workspaces"
{  "workspaces": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",      "name": "string",      "title": "string",      "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",      "lifetimePolicy": "ephemeral",      "expiresAt": "string",      "gitBranch": "string",      "cpuBaseline": "string",      "vmm": "string",      "currentCheckpointId": "58a17ea9-e017-4666-a39c-b13b4cc338f7",      "status": "active",      "lease": {        "sandboxId": "5b4b1d3f-21e4-43f6-8ac1-b460b150f885",        "epoch": "string",        "expiresAt": "string",        "live": true      },      "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",      "createdAt": "string",      "updatedAt": "string",      "lastActivityAt": "string"    }  ]}

Status of a sandbox's environment services GET

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.

Create a workspace POST

Creates a workspace: durable work that outlives any one sandbox. It starts asleep with no execution; attach it to get a sandbox. Its name fixes its git branch, remotehost/<name>. Made with an API key, it belongs to the key's principal: the person who minted the key, or the service account it acts as. 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.