Remotehost Docs
API ReferenceOrg workspaces

Set one end user's cap in an External workspace

PUT
/orgs/{orgId}/workspaces/{workspaceId}/end-user-limits/{endUserId}

Needs billing.manage. Overrides the workspace's default for this end user; null exempts it. 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
endUserId*string

The caller's own end-user id, as given in a sandbox's endUserId, URL-encoded.

Lengthlength <= 128

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 PUT "https://example.com/orgs/string/workspaces/string/end-user-limits/string" \  -H "Content-Type: application/json" \  -d '{    "machineHourLimit": 0  }'
{  "override": {    "endUserId": "string",    "machineHourLimit": 0,    "updatedAt": "string"  }}

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.

List an External workspace's end users with their usage and caps GET

Needs `billing.read`. Every end user with usage in the workspace's projects this billing period, an override, or a notice, by machine-hours descending, with the cap that holds it and whether it reached it. An API key may call it; a key pinned to a workspace only for its own, and any other workspace answers it the same 404 as one that does not exist. An Internal workspace has no end users: every operation here answers it with 409 `internal_workspace`. Off until the workspace API is enabled for this deployment: until then it answers 404 to everyone.