Skip to content
Anlyon
Esc
↑↓navigate↵open⌘Jpreview

List API-key budgets

List configured key budgets with current-month usage and estimated spend. An API-key or OAuth caller sees only keys in its own environment; a dashboard session sees the whole workspace.

GET/api/v2/budgets
Authorization
AuthorizationBearer token (Anlyon API key) · headerrequired

Workspace API key sent as Authorization: Bearer <key>.

or
better-auth.session_tokenAPI key · cookierequired

Browser session used by dashboard-only operations.

Header parameters
X-Request-Idstring

Optional caller correlation ID. Unsafe or oversized values are replaced.

max length 128
Responses
200

Budgets returned.

successbooleanrequired
Allowed:true
dataBudget[]required
Show properties
Array of Budget
workspaceIdstring<uuid>required
apiKeyIdstring<uuid>required
monthlyCostCentsCapinteger | nullrequired
min 0
dimensionCapsBudgetDimensionsrequired
Show properties
messagesinteger
min 0
eventPublishesinteger
min 0
cacheLookupsinteger
min 0
memoryOpsinteger
min 0
actionInvokesinteger
min 0
alertThresholdnumberrequired
min 0.1 · max 1
enabledbooleanrequired
usageobjectrequired
Show properties
messagesintegerrequired
min 0
eventPublishesintegerrequired
min 0
cacheLookupsintegerrequired
min 0
memoryOpsintegerrequired
min 0
actionInvokesintegerrequired
min 0
estimatedCostCentsnumberrequired
min 0
reconciliationRequiredbooleanrequired

Legacy current-month usage is unknown. Budgeted admissions return 503 BUDGET_RECONCILIATION_REQUIRED until an operator imports a verified usage floor; displayed usage is incomplete while true.

alertedAtstring<date-time> | nullrequired
401

Unauthorized - Invalid or missing API key

successbooleanrequired
requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired
Show properties
codestring
messagestring
detailsobject
403

Authenticated credential lacks the required scope or workspace access.

successbooleanrequired
requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired
Show properties
codestring
messagestring
detailsobject
429

Too Many Requests - Rate limit exceeded

successbooleanrequired
requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired
Show properties
codestring
messagestring
detailsobject
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.anlyon.com/api/v2/budgets' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "success": true,
  "data": [
    {
      "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
      "apiKeyId": "37ba0474-c0bb-4910-bfb5-d6cebb614366",
      "monthlyCostCentsCap": 0,
      "dimensionCaps": {
        "messages": 0,
        "eventPublishes": 0,
        "cacheLookups": 0,
        "memoryOps": 0,
        "actionInvokes": 0
      },
      "alertThreshold": 0.1,
      "enabled": true,
      "usage": {
        "messages": 0,
        "eventPublishes": 0,
        "cacheLookups": 0,
        "memoryOps": 0,
        "actionInvokes": 0
      },
      "estimatedCostCents": 0,
      "reconciliationRequired": true,
      "alertedAt": "2019-08-24T14:15:22Z"
    }
  ]
}