API client secrets can be renewed manually or on a schedule. You need permission to manage API clients and must coordinate the change with the person maintaining the integration.

In this article you will learn how to configure secret rotation and retrieve a replacement secret.

Prepare the renewal

1. Open the API client configuration in Admin.
2. Enable scheduled rotation if required, set the rotation interval, transition period and notification email address, then save.
3. Use the client actions to start a manual rotation when needed.

Retrieve and replace the secret

1. Open the one-time link sent to the configured email address.
2. Enter the verification code sent to that address and retrieve the secret.
3. Update the integration before the replacement deadline shown with the secret.
4. Review the client’s rotation history to check the outcome. If necessary, request a new retrieval link from the client actions.

Note The replacement is shown once. Coordinate the integration update within the transition period.