Skip to main content
PATCH
Update the name of an API key
Legacy endpoint - deprecated. Unversioned endpoints are scheduled for removal on July 31, 2026. A public v1 replacement is not currently listed in the v1 reference. This endpoint remains available for existing integrations until then.
Updates the display name of an existing API key. The secret value is not regenerated and the key’s permissions are unchanged, only the human-readable label is updated. Use this when teams, environments, or downstream services are renamed and you want the key list to keep showing the right context at a glance.

When to use this

API keys are typically named for the system or environment that owns them (for example Production Server, Staging Worker, Acme CRM Integration). Rename a key when:
  • A consumer service is renamed and the existing label no longer matches.
  • Ownership moves between teams and the new owner needs the key list to reflect the handover.
  • A key was created with a placeholder name (temp, test) and should be relabelled before going to production.
If you want to rotate the secret instead of just the label, you must create a new key with Create API Key, update all consumers, then revoke the old one with Revoke API Key.

Behavior

  • The id and secret value are unchanged.
  • The last_used_at timestamp is unaffected.
  • The key remains active throughout the rename.

Path parameters

Errors

  • 404 Not Found is returned when the API key does not exist or has been revoked.
  • 400 Bad Request is returned when the name field is missing or empty.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-organization-id
string
required

RSA encrypted organization ID (base64 format)

Example:

"BASE64_ENCRYPTED_ORG_ID_HERE"

Path Parameters

id
string
required

Body

application/json
name
string
required

New label for the API key

Example:

"CI Pipeline Key"

Response

200 - application/json

API key name updated