Keys

Rename key

Only label can be modified; revoked keys can also be renamed.

patch/keys/{key_id}

Request

  • Base URL: https://console-api.blockvectra.com/v1
  • URL: https://console-api.blockvectra.com/v1/keys/{key_id}
  • Auth: HTTP bearer

Path parameters

key_idstring required

Request body

labelstring required

1–64 characters, without control characters.

Response

Renamed key.

key_idstring required
labelstring required

1–64 characters, without control characters.

status'active' | 'disabled' | 'revoked' required
cu_per_secinteger required

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_cuinteger required

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_atstring date-time required

RFC 3339 UTC, second precision, ending in Z (2026-09-26T08:00:00Z); no fractional seconds, without +00:00 timezone offsets.

created_by'console' | 'operator' required

console for self-created by client, operator for created by support.

revoked_atstring date-time required

RFC 3339 UTC, second precision, ending in Z (2026-09-26T08:00:00Z); no fractional seconds, without +00:00 timezone offsets.

replaced_by_key_idstring nullable required

New key created from rotation; null if never rotated.

cu_capinteger nullable required

Lifetime CU cap for this key; null if unlimited. Inherited by rotated new key.

cu_spentinteger required

Settled CU counted toward key cap (settled hourly; excludes unsettled usage in latest period); inherited by rotated new key.

expires_atstring date-time required

RFC 3339 UTC, second precision, ending in Z (2026-09-26T08:00:00Z); no fractional seconds, without +00:00 timezone offsets.

Example response

{
  "created_at": "2026-09-26T08:00:00Z",
  "revoked_at": "2026-09-26T08:00:00Z",
  "expires_at": "2026-09-26T08:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.