How to rotate your api key with the /api/rotateKeys endpoint

Prerequisites

Tools needed

• Postman https://www.postman.com/

• A secure place to keep your credentials

Values Needed

• Your Credentials

  • KeyId (Basic Auth Password)

  • ApiKey (Basic Auth KeyId)

• The domain url associated with the Environment you are working in.

Download the Postman Files and Import them into your Postman

• Collection

• Environment

Rotating your key

1. Go to your environments and open the Self Rotate Key Environment

   1. Update the domain Current Value to the Domain Should be one listed above

   2. Update basicAuthUserName_KeyId Current Value equals your current KeyId

   3. Update basicAuthPassword_ApiKey Current Value equals your current ApiKey

2. Save your Environment

3. Go to your collections and open the Self Rotate Key Collection

4. Open the Self rotate request

5. Confirm your variables (optional)

   1. Hover over the domain, ensure the correct variable

   2. Go to the Authorization tab, ensure the Auth Type is basic

      1. Hover over basicAuthUserName_KeyId ensure the Username is your KeyId

      2. Hover over basicAuthPassword_ApiKey ensure the Password is you ApiKey

6. Once you have filled your environment variable go ahead and click “Send”. This will create a Post call that updates your credentials.

7. In the Response body will be your Updated credentials.

   1. Result looks like this

   2. Note, there is a script that will update your credentials in postman.

8. Save this in a secure location.

Troubleshooting

• Did you save your environment? it is easy to forgo this step. As anyone whom has worked with Postman has probably forgotten this critical step before.

• Ensure there are no spaces in your environment variables

• Make sure the url is the correct one

• Did you accidentally swap your KeyId and ApiKey?