Guides

Create and Manage API Keys

Create and rotate API keys for secure programmatic access.

Create and Manage API Keys

API keys provide programmatic access for automation jobs and service clients. Teams should manage keys as lifecycle assets: assign purpose, set ownership, rotate on schedule, and revoke quickly when no longer needed.

What to Click and Do Next

  1. Open Settings.
  2. Click Account > API keys.
  3. Click Generate Api Key.
  4. In Create New API Key, provide Description, API Version, and optional Expires at.
  5. Click Create.
  6. Copy the key and store it in an approved secret manager.

Maintain and Rotate Keys

  1. Use edit (pencil) to update metadata or API version alignment.
  2. For rotation, create a new key first.
  3. Update all clients to use the new key.
  4. Validate successful API calls.
  5. Revoke the old key.

Validation Checklist

  1. New key authenticates successfully.
  2. Intended client can call target endpoint.
  3. Old key is revoked after migration.

Common Issues

  • 401 responses caused by wrong account context or incorrect key copy.
  • API keys page missing due to role/feature restrictions.