API Keys

Create the API Keys to securely retrieve the authentication credentials for making StablR API requests.

API Keys and their respective Client Secret as well as associated Client ID are unique strings of data that you need to use to request an authentication token as a programmatic user of the StablR API. These data strings should be stored securily and kept confidential at all times.

🚧

Securely store your API Keys and Credentials

Since the API Keys and corresponding credentials allow you access to sensitive operations using the StablR API, you are responsible to keep the safe!

  • Ensure this data is stored securely.
  • Never share this data or record it in public accessible media.

Warning: If you lose control of your API Keys and Credentials, please revoke them as soon as possible via your StablR Account to prevent suffering financial loss.


Manage your API Keys

To manage your API Keys you need to access the StablR Account and go the Account > Management > API Management dashboard. In this dashboard you can view, add, edit and revoke your API keys.

πŸ“˜

API Management

To manage your API Keys you need to be an Admin user in your StablR Account.


Create an API Key

To create an API Key, access the StablR Account and go to the Account > Management > API Management dashboard, then select Create API Key.

Subsequently, provide the following input:

  1. Enter a Name for the API Key.
  2. Select the Role(s) which provide your API Key with their respective permissions.
  3. Provide IP addresses for your IP whitelist (Maximum of 10 IP addresses can be added per API Key).
  4. Click Add.

Copy the API Client Secret and close the pop-up window. Make sure to store the API Client Secret in a secure place.


Edit API Key details

To edit an API Key, access the StablR Account and go to the Account > Management > API Management dashboard, then select an API Key from the overview.

  • In within the API Key details you are only able to change the IP whitelist IPs.

After editing an API Key, click Save.


Revoke an API key

To revoke an API Key, access the StablR Account and go to the Account > Management > API Management dashboard, then select an API Key from the overview.

Subsequently:

  1. Select Revoke.
  2. And confirm revoking by clicking Revoke in the pop-up window.

What’s Next