API Keys

How to use this page

1. 1

   Check the status

   The status band shows whether an active key is ready, the base API URL (with a Copy button), the total request count, and how many revoked keys are retained. If there is no active key, create one before connecting an integration.

2. 2

   Create a key

   When no active key exists, name it (for example, Production API Key) and click Create API key. The full key is shown only once, so click Copy and store it in your integration's secret manager immediately.

3. 3

   Rename or review the active key

   The Active Key card shows the masked key plus when it was created, last used, and how many requests it has served. Click Rename to relabel it; the masked value and stats stay the same.

4. 4

   Rotate or revoke

   Rotate key immediately revokes the current key and issues a new one (copy the new value right away). Revoke key disables the key without a replacement. Both ask you to confirm, since any integration using the old key stops working until updated. Rotated and revoked keys move to Key History, kept for audit reference with their masked value and timestamps.

What the buttons do

View API docs

Opens the public Platform API documentation.

Copy (base URL)

Copies the public API base URL to paste into your integration.

Create API key

Generates the client's one active key. The full value is shown only once at creation.

Copy (key value)

Copies the full key shown at creation. Store it in a secret manager; it cannot be shown again.

Rename

Relabels the active key without changing its value.

Rotate key

Revokes the current key and issues a new one. Confirmed, because the old key stops working immediately.

Revoke key

Disables the active key with no replacement. Confirmed.

Common questions