Remotehost Docs
API ReferenceOrg workspaces

Set an External workspace's default end-user cap and the action at it

PATCH
/orgs/{orgId}/workspaces/{workspaceId}/end-user-limits

Needs billing.manage. Sandbox create and wake check the org's cap, the workspace's, the project's, then the end user's. An Internal workspace has no end users: every operation here answers it with 409 internal_workspace. API keys cannot call it. Off until the workspace API is enabled for this deployment: until then it answers 404 to everyone.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

orgId*string
workspaceId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/orgs/string/workspaces/string/end-user-limits" \  -H "Content-Type: application/json" \  -d '{}'
{  "workspace": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "kind": "internal"  },  "defaultMachineHourLimit": 0,  "action": "refuse_new",  "overrides": [    {      "endUserId": "string",      "machineHourLimit": 0,      "updatedAt": "string"    }  ]}

Read an External workspace's end-user caps GET

Needs `billing.read`. The default cap per end user, the action at the cap, and every override. An Internal workspace has no end users: every operation here answers it with 409 `internal_workspace`. API keys cannot call it. Off until the workspace API is enabled for this deployment: until then it answers 404 to everyone.

Remove one end user's cap override DELETE

Needs `billing.manage`. The end user goes back to the workspace's default. An Internal workspace has no end users: every operation here answers it with 409 `internal_workspace`. API keys cannot call it. Off until the workspace API is enabled for this deployment: until then it answers 404 to everyone.