Update an API key
Renames a key and, for a publishable key, replaces its allowed origins and limits. Omitted fields are unchanged; policy fields on a full or read key return 400. Served by the Activity host for all products. Read-only and publishable keys get 403.
Authorizations
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
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.
"00000000-0000-4000-8000-000000000000"
Body
New label, 1 to 100 characters.
1 - 100Publishable 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.
1 - 20 elementsExact origin, scheme://host[:port], normalized to lowercase without a default port.
Publishable keys only: requests per minute per end-user IP (default 60). The organization plan limit still applies.
1 <= x <= 600Publishable keys only: set a cap, or null to remove it.
1 <= x <= 1000000000000Response
The updated key metadata.
mainnet, testnet full, read for data-only keys, or publishable for browser keys. Rotation keeps it (and a publishable key's origins and limits; its cap counter starts again), and a key created with an expiry passes the same lifetime, counted from the rotation, to its replacement.
full, read, publishable Set by a creation-time expiry or while a rotated key is in its overlap window. The key stops working at this time.
The key this one replaced.
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.
1 - 20 elementsExact origin, scheme://host[:port], normalized to lowercase without a default port.
Publishable keys only: requests per minute per end-user IP (default 60). The organization plan limit still applies.
1 <= x <= 600Publishable 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.
1 <= x <= 1000000000000