Skip to main content
PATCH
Set threshold config

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Body

application/json

Full replacement of the tenant-wide threshold config — always set in full, no patch semantics.

thresholds
integer[]
required

Percentages of usageLimit that trigger a threshold-crossed alert (e.g. [50, 80, 100]). Applies to every assignment in the tenant.

Maximum array length: 10

Percentages of usageLimit that trigger a threshold-crossed alert (e.g. [50, 80, 100]). Applies to every assignment in the tenant.

Required range: x >= 1

Response

The threshold config after upsert.

Response object

data
ThresholdConfig · object
required

A single tenant-wide alert curve for usage-threshold-crossed alerts, shared by every assignment regardless of capability — not configured per-budget.