Manage API keys

An API key is a unique identifier used to authenticate a user, developer, or an application to an API. You can add API keys to your organization and revoke them when you are finished using them.

Before you begin

Make sure you have the following before you begin:

• owner role in your organization

Add API keys

You can add API keys to your organization if you need to access the Redocly API or the Scout tool.

To add an API key to your organization:

1. Log in to your Redocly instance.
2. Select API keys in the navigation menu on the left side of the page.
3. Click New key.
4. Enter a name for your key.
5. (Optional) Enter allowed IP addresses.
6. Click Save.
7. Click the copy icon to the right of the newly created API key to save it to your clipboard. Save the key somewhere safe, as you can't access it later.

Revoke API keys

When you are finished using an API key, you can revoke the key, making it an invalid authentication method.

1. Log in to your Redocly instance.
2. Select API keys in the navigation menu on the left side of the page.
3. Click Revoke next to the API key you want to revoke.
4. Click OK.