Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <key>. Testnet: lum_test_…; Mainnet: lum_live_…. A key works only on its own network, so pick the server that matches it (the other network answers 401). Publishable lum_pub_… keys call the GET data routes only, from an allowed browser origin. Webhook keys (whk_…) are not accepted here.

Path Parameters

id
string<uuid>
required

API key ID: id from GET /v1/keys or from the create response. The example ID is a placeholder and answers 404: use your own.

Example:

"00000000-0000-4000-8000-000000000000"

Body

application/json
overlap_seconds
integer

How long the old key keeps working: 0 revokes it now. Default 86400 (24 hours), maximum 604800 (7 days).

Required range: 0 <= x <= 604800

Response

The replacement key (api_key shown once) and the old key in previous.

id
string<uuid>
required
name
string
required
api_key
string
required

Plaintext returned once. Never log or share a full or read key; a publishable key (lum_pub_…) is meant to be embedded in web pages.

key_prefix
string
required
network
enum<string>
required
Available options:
mainnet,
testnet
base_url
string
required
created_at
string<date-time>
required
expires_at
string<date-time> | null
required

The new key's expiry: null unless the old key had one, in which case the same lifetime restarts at the rotation. The old key's overlap end is previous.expires_at.

rotated_from
string<uuid>
required
previous
object
required
access
enum<string>

full, read for data-only keys, or publishable for browser keys.

Available options:
full,
read,
publishable
allowed_origins
string[]

Publishable keys only: a request must send an Origin header equal to one of these. HTTPS is required except http://localhost and http://127.0.0.1; no wildcards; at most 150 characters each.

Required array length: 1 - 20 elements

Exact origin, scheme://host[:port], normalized to lowercase without a default port.

rate_limit_per_minute_per_ip
integer

Publishable keys only: requests per minute per end-user IP (default 60). The organization plan limit still applies.

Required range: 1 <= x <= 600
monthly_credit_cap
integer

Publishable keys only: settled credits this key may use per billing period. At the cap the key gets 429 until the next period; other keys continue. Omitted when there is no cap.

Required range: 1 <= x <= 1000000000000