Usage

Evaluate administrative usage limit headroom

Changed on

Evaluate the effective usage limits for a selector and return the current decision (AVAILABLE, WARNING, or BLOCKED) based on accrued usage. Requires admin.usage:evaluate and permission to read workspace billing, not a global administrator role. An explicit usage_selector.client_id selects the Glean or external spend client; it is never inferred from the caller. Returns all applicable limit values and counters, with effective headroom separated by unit. Agent counters retain aggregate scope. Billing readers receive exact IdP-group source identities. A USER target may be identified by user_id or email. Evaluation reports configured-budget status even when runtime enforcement switches are off; it does not perform request admission, model eligibility, or agent-run preflight checks.

post/api/admin/usage/limits/evaluate

Request

  • Base URL: https://instance-name-be.glean.com
  • URL: https://instance-name-be.glean.com/api/admin/usage/limits/evaluate
  • Auth: HTTP bearer

Request body

usage_selectorunknown required

Response

Evaluation result.

PlatformEvaluateUsageLimitResponse required(unresolved $ref)

Changes