API Keys
Rename API Key
deprecated
Update the display name of an existing API key without changing its secret value or capabilities.
PATCH
Update the name of an API key
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 exampleProduction 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.
Behavior
- The
idand secret value are unchanged. - The
last_used_attimestamp is unaffected. - The key remains active throughout the rename.
Path parameters
Errors
404 Not Foundis returned when the API key does not exist or has been revoked.400 Bad Requestis returned when thenamefield is missing or empty.
Related endpoints
- List API Keys: confirm the renamed key in your portfolio.
- Create API Key: issue a new key when you need to rotate the secret.
- Revoke API Key: permanently retire a key.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
RSA encrypted organization ID (base64 format)
Example:
"BASE64_ENCRYPTED_ORG_ID_HERE"
Path Parameters
Body
application/json
New label for the API key
Example:
"CI Pipeline Key"
Response
200 - application/json
API key name updated
Update the name of an API key