API Reference

API Keys


When making programmatic calls to the Gremlin API, instead of using your own account profile with your username password credentials, you can leverage team-level API keys. This is akin to having a "service account" in other software products.

To create a new API key

  1. Go to Company Settings.
  2. Select your Team.
  3. Select the API Keys tab.
  4. Click New API Key button.
  5. Give your key a unique name and an optional description.
  6. Click save, and copy your key content for use.

To revoke and reinstate an API Key

  1. Before you begin, confirm that you have stopped using the API Key.
  2. Go to Company Settings.
  3. Select your Team.
  4. Select the API Keys tab.
  5. Hover over the 3 dots to the right of your API Key.
  6. Select Revoke Key or Reinstate Key in the popup.
  7. If you are revoking a key, confirm by clicking the Revoke button.

Usage

Instead of using a Bearer token, provide the key content in the Authorization Header, prefixed with Key.

Authorization: Key f02868098b13e4f68da82b0c5e5c950ea750fce53c62d982cdab0c61099e5f98

See Creating Attacks for examples of creating an attack via the API.

Limit

There is a limit of 5 active API Keys per team.