CyberRXN Docs
APIAPI reference

API key quotas and current usage windows

GET /v1/key-limits

GET /v1/key-limits

API overview · OpenAPI

First-party session with apiKey:read or limits:read. Calendar days start at 00:00 UTC, weeks on Monday, months on their first day. Reserved calls count until success or refund; errors and non-billable operations do not consume a quota.

Authorization

This operation requires a bearer credential. The description defines additional role, scope or first-party-session restrictions; an API key does not grant those permissions by itself.

Parameters

PropertyTypeRequiredDetails
key_id (query)string ∣ nullno

Request body

No request body.

Responses

HTTPDetailsType
200Successful Responseapplication/json: KeyLimitList
401Unauthorizedapplication/problem+json: ProblemDetails
403Forbiddenapplication/problem+json: ProblemDetails
404Not Foundapplication/problem+json: ProblemDetails
422Unprocessable Entityapplication/problem+json: ProblemDetails

Response: KeyLimitList

PropertyTypeRequiredDetails
itemsKeyLimitStatus[]yes
timezonestringyes
currencystringyes
microusd_per_usdintegeryes
Full schema
{
  "properties": {
    "items": {
      "items": {
        "$ref": "#/components/schemas/KeyLimitStatus"
      },
      "type": "array",
      "title": "Items"
    },
    "timezone": {
      "type": "string",
      "const": "UTC",
      "title": "Timezone"
    },
    "currency": {
      "type": "string",
      "const": "USD",
      "title": "Currency"
    },
    "microusd_per_usd": {
      "type": "integer",
      "const": 1000000,
      "title": "Microusd Per Usd"
    }
  },
  "type": "object",
  "required": [
    "items",
    "timezone",
    "currency",
    "microusd_per_usd"
  ],
  "title": "KeyLimitList"
}

This page is generated from OpenAPI; examples are schemas, not a fabricated successful response.

Usage and billing · Structured errors

On this page