List API key token rate policy history

Generated from the checked-in source. Do not edit this reference by hand.

GET /api/v1/organizations/{organization}/projects/{project}/keys/{key}/token-rate-limit/history

Scoped readers receive descending revisions shared across rotations. Use the last revision as the next page cursor.

Operation: listKeyTokenRateLimitHistory.

Authentication

Use the credential and permission scope described above. Each object below is an alternative; schemes within one object are required together.

JSON

[
  {
    "bearerAuth": []
  }
]

HTTP request

Set NIU_ORIGIN to your installation origin (without /v1). Replace path, query and header placeholders with the required values. Query examples use curl 7.87 or newer to encode values with --url-query. Use the credential scope described above; a bearer token must have the authority required by this operation.

Shell

curl --fail-with-body -X GET "$NIU_ORIGIN/api/v1/organizations/{organization}/projects/{project}/keys/{key}/token-rate-limit/history" \
  -H "Authorization: Bearer $NIU_BEARER_TOKEN"

Parameters

organization

Location: path. Required.

JSON

{
  "type": "string",
  "format": "uuid"
}

project

Location: path. Required.

JSON

{
  "type": "string",
  "format": "uuid"
}

key

Location: path. Required.

JSON

{
  "type": "string",
  "format": "uuid"
}

before_revision

Location: query. Optional.

JSON

{
  "type": "integer",
  "minimum": 1
}

limit

Location: query. Optional.

JSON

{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 50
}

Request body

No request body is declared.

Responses

HTTP 200

Immutable policy history; no internal actor identifiers.

Content type: application/json.

JSON

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "tokens_per_minute",
          "revision",
          "recorded_at",
          "actor_kind",
          "actor_name"
        ],
        "properties": {
          "tokens_per_minute": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 0,
            "maximum": 1000000000000,
            "description": "Token budget includes unresolved reservations plus provider-reported usage completed in the last 60 seconds. Null is unlimited; zero denies dispatch."
          },
          "revision": {
            "type": "string",
            "pattern": "^[1-9][0-9]*$"
          },
          "recorded_at": {
            "type": "string",
            "format": "date-time"
          },
          "actor_kind": {
            "type": "string",
            "enum": [
              "installation",
              "member"
            ]
          },
          "actor_name": {
            "type": "string"
          }
        }
      }
    }
  }
}

HTTP 400

Invalid pagination

HTTP 401

Authentication required

HTTP 403

Workspace access denied

HTTP 404

Workspace is outside operator scope, or key is absent from authorized workspace

Behavior and supported scope

Scoped readers receive descending revisions shared across rotations. Use the last revision as the next page cursor.

Supported scope: implemented