Generating your API key

Here, you will find everything you need for verification before accessing Adjútor

The steps are the same as defined in the Getting Started section. But for the sake of a refresher, find the steps below:

1. Log in to your dashboard at https://app.adjutor.io/login

2. Navigate to the 'Apps’ menu

3. Click on the 'Create an app' button (located at the top right section of the page) and enter the required details.

4. While creating an app ensure you select all necessary API services you wish to access.

5. Click on 'save details' and the key would be displayed on your screen for you to copy and paste within the environment variable of your application.

Resetting your API Key

If at any point, you suspect that your key has been compromised, the API key should be instantly revoked and regenerated. This can be done within the same Admin panel where the key was previously generated. Find the steps below:

1. Log in to your dashboard at https://app.adjutor.io/

2. Navigate to the 'Apps’ menu'

3. Click on the particular app whose API key you wish to reset.

4. Click on "Reset app key"

Notes

1. If you do not include your API key when making a request, or you use an incorrect/outdated key, the request will fail.

2. Your API keys carry many privileges, so be sure to treat it as you would any other password and grant access only to those who need it. Do not share your secret API keys in publicly accessible areas such as GitHub, etc.

3. If a token is compromised, you can re-generate a new one from your dashboard.

Warning

Regenerating a new key would immediately revoke your existing key therefore the change should be carefully planned to prevent downtime for your apps and customers.