Skip to content

Getting started with the AQtive Guard API↑

Before you begin using the AQtive Guard API or completing the API tutorials, you’ll need the following:

  • Your AQtive Guard API key. For instructions, see Retrieve the API key, below.
  • A trace to upload. For instructions on generating a trace, please see the sensor documentation in the Sensors section of this guide.
  • A command-line client to interact with the API. The tutorials use the open-source curl HTTP client, which is available for most platforms.

Retrieve the API key↑

To retrieve the AQtive Guard API key:

  1. Log into the AQtive Guard web interface as an Admin.
  2. Select Settings from the menu bar, then select API.
  3. In the bottom right of the API Explorer window, select Reset API Key. Store the New API Key securely before leaving the page.

Tip

If the Reset API Key button isn’t visible, it may be hidden by the API Explorer terminal. Resize the terminal by dragging the right edge of the window until the button appears in the bottom-right corner of the screen.

Info

For security, the API key is only given once. If you forget it, you must repeat this reset procedure to retrieve a new key.