Remotehost Docs
API ReferenceEnvironment templates

Get an environment template

GET
/orgs/{orgId}/projects/{projectId}/environment-templates/{environmentId}

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
environmentId*string
Formatuuid

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/environment-templates/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "environment": {    "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"  }}

Create an environment template POST

A named, reusable machine configuration that workspaces reference. Requires environments.manage. Secrets are not accepted yet.

Update an environment template PATCH

Fields left out are unchanged; null clears a nullable one. Moving to the none or full egress policy clears the allowlist. Changing egressPolicy or egressAllowlist requires environments.egress.manage; changing any other field requires environments.manage; a request that does both requires both. A change to egressPolicy or egressAllowlist, or to whether the project is enforced, is pushed to the running sandboxes it affects as it is saved; one the push cannot reach is stopped so it cannot keep the old rules, and the response's egressPropagation says which.