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

  View file
  name Self Rotate Key.postman_collection.json

• Environment

  View file
  name Self Rotate Key.postman_environment.json

Rotating your key

...

1	Configure Postman Environment	Inside of Postman Environment open theSelf Rotate KeyEnvironment Update the domain Current Value to the Domain Should be one listed above Update basicAuthUserName_KeyId Current Value equals your current KeyId Update basicAuthPassword_ApiKey Current Value equals your current ApiKey Image Added
2	Save your Environment

...

Image Added
3	Configure/Check Self Rotate Key Collection

...

Open the Self rotate request

...

Hover over the domain, ensure the correct variable Go to the Authorization tab, ensure the Auth Type is basic Hover over basicAuthUserName_KeyId ensure the Username is

...

the current KeyId Hover over basicAuthPassword_ApiKey ensure the Password is

...

the current ApiKey Image Added
4	Send the request	Once you have filled your environment variable go ahead and click “Send”. This will create a Post call that updates your credentials.

In the Response body will be your Updated credentials.

...

Image Added Info Note, there is a script that will update your credentials in postman. This will allow you to easily just run in the next time.
5	Save

...

your credentials somewhere secure

Your ApiKey will only be shown this one time. Image Added

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?

...