v1

latestOpenAPI 3.1.02026-08-044257268.7 KB

Controls

Get a workspace budget control

get/v1/controls/workspace/budgets/{budgetControlId}

budgetControlIdstring required

Budget control ID (ULID).

Example:01JC2Z0A9V8Q4R6T8Y0B2D4F6H

Budget control ID (ULID).

Budget control

budgetControlIdstring required

Budget control ID (ULID).

workspaceIdstring required

period'HOUR' | 'DAY' | 'WEEK' | 'MONTH' required

limitAmountnumber required

Budget cap for the window, in dollars.

spentAmountnumber required

Settled spend in the current window, in dollars.

heldAmountnumber required

Outstanding holds for in-flight runs, in dollars.

availableAmountnumber required

limitAmount - spentAmount - heldAmount, in dollars.

currency'USD' required

windowStartstring date-time required

ISO 8601 — which window the counters represent.

status'ACTIVE' | 'PAUSED' required

createdAtstring date-time required

updatedAtstring date-time required

{
  "budgetControlId": "01JC2Z0A9V8Q4R6T8Y0B2D4F6H",
  "limitAmount": 100
}