Keys

Create key (secret displayed only once)

Create an active API key; free-account default CU limits are returned by GET /plans in key_defaults and paid-account lower bounds in paid_key_minimums when published; the actual limits of a key are cu_per_sec and burst_cu on GET /keys. The new key is usable within about 5 seconds. Optional cu_cap sets a lifetime CU cap; expires_in_secs and expires_at are mutually exclusive expiration options. An expired key returns 403 key_expired; an exhausted cap returns 403 key_cap_exhausted. Rotation preserves the cap and expiration.

post/keys

Request

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

Request body

labelstring required

1–64 characters, without control characters.

cu_capinteger

Lifetime CU cap for this key; unlimited if omitted.

expires_in_secsinteger

Seconds until expiration from current server time (converted to absolute time); mutually exclusive with expires_at.

expires_atstring date-time

Expiration timestamp, RFC 3339 string with timezone (Z or offset); must be in the future within maximum validity; mutually exclusive with expires_in_secs.

Response

New key and its secret (api_key, displayed only this once).

api_keystring required

Key secret, displayed only this once.

Example response

{
  "key": {
    "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.