Skip to main content

Setting Up API Key Based Authentication

Step 1 - Create an authentication setup

From the CONFIGURATION MENU select Authentication Settings and Click Create New Authentication.

Auth Settings list with the Add New Auth Setting button highlighted to start creating an authentication

Select the authentication type from the menu and complete the data for the authentication type. This could be simple, for an API Key, or require adding the necessary call back URIs and ClientID and Secret for an OAuth flow.

Saved Example API Key auth setting set to Manual Setup, with no tokens yet and a Create New Token button

Create a Token

For the simple API Key example, select where in the monitor you place the API Key and set the correct parameters.

Token wizard for the API key setting with header and parameter key-value fields to place the API key

Use the Auth Settings in a call

When you setup or edit a call next, you can then add your authentication setting and the token directly to the call in the call editor.

Monitor call editor with the authentication setting and token selected to apply the API key to the call