POST/v1/team/key/{publicIdOrKey}

Regenerates an API key by removing the specified key, generating a new one and returning its value

Requires permission ACCESS_MANAGEMENT or ACCESS_MANAGEMENT_CREATE

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
publicIdOrKeystringrequired
The public ID for the API key or for Legacy the complete Key to regenerate

3 status codes
200The re-generated API key
commentstringoptional
createdintegeroptional
UNIX epoch timestamp in milliseconds
expiresAtintegeroptional
UNIX epoch timestamp in milliseconds
keystringoptional
lastUsedintegeroptional
UNIX epoch timestamp in milliseconds
legacybooleanoptional
maskedKeystringoptional
publicIdstringoptional
401Unauthorized
404The API key could not be found

Error handling

A 401 is returned: Unauthorized. A 404 is returned: The API key could not be found.