Skip to main content

Create and revoke an API key

An API key lets a supported integration access ChangePilot using your account's permissions. Create a separate, clearly named key for each integration so you can identify and revoke access

Written by Tom Arbuthnot

An API key lets a supported integration access ChangePilot using your account's permissions. Create a separate, clearly named key for each integration so you can identify and revoke access without disrupting everything else.

Create a key

  1. Open API in the main navigation, or go to the API page at app.changepilot.cloud/api.

  2. Find API keys and choose New key.

  3. Enter a name that identifies its purpose, such as Claude desktop on work laptop.

  4. Choose Create.

  5. Copy the full key while it is displayed and store it in the approved secret or credential setting for your integration.

  6. Choose Done and confirm the key appears in the list.

The full key is shown only when created. If you lose it, create a replacement and revoke the unused key. The visible prefix helps identify a key but cannot be used in place of the full secret.

Use the key appropriately

Keys inherit your access; they do not upgrade a subscription or grant access to another person's organisation. Check your account's current integration entitlement if a key is accepted but a tool or dataset remains unavailable.

Treat a key like a password. Keep it out of source control, shared screenshots, email, support messages and AI chat prompts. Configure it in the client's credential or environment settings, rather than asking the assistant to remember it.

Replace or revoke a key

For a planned replacement, create the new key, update the integration and check a read operation, then revoke the old key. If a key may have been exposed, revoke it promptly and configure a replacement.

In API keys, use the key name, prefix, created date and last-used information to identify the intended key, then choose Revoke. Revocation is irreversible and can take around a minute to propagate. Any client still using the old key must be updated before it can work again.

When authentication fails

Check for a truncated key, accidental whitespace, revocation and the account's access level. Restart the local MCP client after changing its environment configuration. Share an error message and key name or prefix with support if needed, never the full key.

Access

Creating API keys requires Plus or an activated Plus trial. A key inherits the account's permissions and does not grant Free access to a paid integration.

Related guides

Did this answer your question?