overlane api-key limits | Overlane Docs

Prints the per-minute request limit that applies to the team’s API keys (from the plan data file), the calls left in the current minute and when it resets. A call over the limit gets 429 with Retry-After and the RateLimit-* headers.

Usage

overlane api-key limits [--service URL] [--team TENANT_ID]

Flags

Flag	Type	Required	Default	Description
`--service`	string	no		The service address (default: OVERLANE_SERVICE_URL, then the project’s binding, then the hosted service)
`--team`	string	no		The team (tenant) to act on (default: the one your token belongs to)

Examples

overlane api-key limits
overlane api-key limits --json

Behavior

Effect: read (changes nothing).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: no. Accepts --force: no.
Machine-readable description: overlane schema api-key limits.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "type": "object",
  "properties": {
    "tenantId": {
      "type": "string"
    },
    "plan": {
      "type": "string"
    },
    "limitPerMinute": {
      "type": "number"
    },
    "remaining": {
      "type": "number"
    },
    "resetsInSeconds": {
      "type": "number"
    },
    "next": {
      "type": "string"
    }
  },
  "required": [
    "tenantId",
    "plan",
    "limitPerMinute",
    "remaining",
    "resetsInSeconds",
    "next"
  ],
  "additionalProperties": false
}

See exit codes for the status the process returns.