KeyView

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/blockvectra/json-schema/blockvectra-key-view-schema.json",
  "title": "KeyView",
  "x-generated": "2026-11-02",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/console.yaml#/components/schemas/KeyView",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "key_id",
    "label",
    "status",
    "cu_per_sec",
    "burst_cu",
    "created_at",
    "created_by",
    "revoked_at",
    "replaced_by_key_id",
    "cu_cap",
    "cu_spent",
    "expires_at"
  ],
  "properties": {
    "key_id": {
      "type": "string",
      "pattern": "^k_[0-9a-f]{12}$"
    },
    "label": {
      "description": "Null for keys created by support.",
      "oneOf": [
        {
          "$ref": "#/$defs/KeyLabel"
        },
        {
          "type": "null"
        }
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "disabled",
        "revoked"
      ]
    },
    "cu_per_sec": {
      "type": "integer",
      "description": "Actual per-key token bucket refill rate (CU/s), including any paid floor or higher custom limit. Effective aggregate across all chains and Data API for this key."
    },
    "burst_cu": {
      "type": "integer",
      "description": "Actual per-key token bucket capacity (CU), including any paid floor or higher custom limit. Effective aggregate across all chains and Data API for this key."
    },
    "created_at": {
      "$ref": "#/$defs/Timestamp"
    },
    "created_by": {
      "type": "string",
      "enum": [
        "console",
        "operator"
      ],
      "description": "`console` for self-created by client, `operator` for created by support."
    },
    "revoked_at": {
      "oneOf": [
        {
          "$ref": "#/$defs/Timestamp"
        },
        {
          "type": "null"
        }
      ]
    },
    "replaced_by_key_id": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^k_[0-9a-f]{12}$",
      "description": "New key created from rotation; null if never rotated."
    },
    "cu_cap": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 9007199254740991,
      "description": "Lifetime CU cap for this key; null if unlimited. Inherited by rotated new key."
    },
    "cu_spent": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991,
      "description": "Settled CU counted toward key cap (settled hourly; excludes unsettled usage in latest period); inherited by rotated new key."
    },
    "expires_at": {
      "description": "Expiration timestamp; null if no expiration. Data plane rejects expired key (403 `key_expired`), status remains `active`. Inherited by rotated new key.",
      "oneOf": [
        {
          "$ref": "#/$defs/Timestamp"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "$defs": {
    "KeyLabel": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "pattern": "^[^\\u0000-\\u001F\\u007F]{1,64}$",
      "description": "1–64 characters, without control characters."
    },
    "Timestamp": {
      "type": "string",
      "format": "date-time",
      "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$",
      "description": "RFC 3339 UTC, second precision, ending in `Z` (`2026-09-26T08:00:00Z`); no fractional seconds, without `+00:00` timezone offsets."
    }
  }
}