Remotehost Docs
API ReferenceEnvironments

List a project's environments

Deprecated

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

Deprecated: use the same operation under /environment-templates. Requires environments.read.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

orgId*string
projectId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/orgs/string/projects/string/environments"
{  "environments": [    {      "usage": {        "workspaces": 0,        "sandboxes": 0      },      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",      "name": "string",      "description": "string",      "isDefault": true,      "enforced": true,      "template": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "platform": true      },      "machineSize": "small",      "vmm": "string",      "setupScript": "string",      "services": [        {          "name": "string",          "command": "string",          "port": 1,          "cwd": "string"        }      ],      "ports": [        0      ],      "envVars": {        "property1": "string",        "property2": "string"      },      "egressPolicy": "none",      "egressAllowlist": [        "string"      ],      "applied": true,      "createdAt": "string",      "updatedAt": "string"    }  ]}

Delete an environment template DELETE

Refused with 409 while any workspace names it, or, for the project's default, while workspaces that name no environment follow it: move them first. Sandboxes do not hold it: if any still boot from it, it is deleted for everything else (no longer listed, readable, editable, the default or usable for anything new) and kept only for them, so each keeps waking under its last egress policy, environment variables and setup script; it is released when the last of them is deleted. Requires environments.manage.

Create an environment POST

Deprecated: use the same operation under /environment-templates. A named, reusable machine configuration that workspaces reference. Requires environments.manage. Secrets are not accepted yet.