These docs are for v2. Click to read the latest docs for v3.

Rotate credentials

To rotate your API client's credentials or another client's credentials, modify a pair of individual credential members.

Rotate credentials for your API client:

  1. Run Update your credential to update the expiration date of an old credential to a new date you choose to let it auto-expire.

  2. Run Create your credential so the new credential can replace the old one.

  3. Deploy your new keys and secrets.

Rotate credentials for a given API client:

  1. Run Update a credential to update the expiration date of an old credential to a new date you choose to let it auto-expire.

  2. Run Create a credential so the new credential can replace the old one.

  3. Deploy your new keys and secrets.

You should leave enough overlap between the old and new credentials to ensure you maintain access during the rotation. If your old credentials expire before you finish updating the new ones, you'll lose access to the APIs assigned to the expired credentials.