Skip to main content
Python

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Headers

X-CSRF-Token
string

Session-bound CSRF token. Required for browser-session calls, together with a matching configured Origin header; omit it when calling with an API key.

If-Match
string
required

Strong ETag returned by the latest read, in the ETag response header and the etag field of the body; a stale value conflicts without changing the resource.

Required string length: 1 - 256
Pattern: ^[^\u0000]*$
Idempotency-Key
string

Optional for this operation. Preserve the same stable identifier when retrying an uncertain response; never reuse it for new work. If omitted where allowed, Cloud generates a request-scoped key that cannot reconcile a later retry. Do not include credentials or payloads. Stable identifier for one logical mutation.

Required string length: 1 - 128

Body

application/json
max_active_jobs
integer
required

New cap on live Actions runners for this workspace, from 1 to 500.

Required range: 1 <= x <= 500

Response

Updated workspace Actions settings revision.

max_active_jobs
integer
required

Cap on live Actions runners this workspace may hold at once. Creating, registered and busy runners count toward it; finished and failed runners do not. The service default applies until the workspace writes a value.

Required range: 1 <= x <= 500
updated_at
string<date-time>
required
etag
string
required
read-only

The strong settings revision, the same value as the ETag response header. Send it as If-Match to update.

Maximum string length: 256