Skip to main content

BlastShield Documentation

Enable the BlastShield API

Tip

BlastShield™ has a REST based public API. The API can be used to automate actions such as list, add, remove and update of Users, Endpoints, Agents, Gateways, Groups and Policy.

Important

Pre-requisites

  1. Your Orchestrator, Gateways, Agents and Clients must be using firmware release 1.2.0 or higher.

  2. You must create an API key in the Orchestrator. This is explained below.

  3. To be able to access the API documentation, you must add API access to your user account. This is explained below.

Summary

  1. Enable API access on your User profile

  2. Configure and create an API key

  3. Connect to the interactive API documentation

Procedure steps

  1. Enable API access on your User profile.

    1. Login to the Orchestrator and click on the Users menu on the left hand side.

    2. The list of users will appear. Click on the User on which you want to enable API Access for.

    3. The User information will open. In the Settings tab, check the API Access box.

    4. Click on Save.

      api-access-step1.png

  2. Create and configure a new API key

    1. Add a new API key by clicking on the API Keys settings menu on the left hand side.

    2. The API Keys menu will open. Click on the Add New API Key on the right hand side.

      api-access-step2.png

    3. The Edit API Key menu will open. Check the boxes according to the permissions you want to set to the API key and click Save to create the API Key.

      api-access-step2-2.png

    4. The API key will be displayed and you must keep a copy of it before you close the window. There will be no way to view it again.

      api-access-step2-3.png

  3. Connect to the interactive API documentation at the following URL:

    https://<orchestrator-fqdn>:8000/docs

    For Orchestrators which are using the default host-name, this will be:

    https://orchestrator.blastshield.io:8000/docs

  4. The interactive API documentation will open as shown below.

    api-access-step3.png

    1. Authorise the API by clicking on the Authorise button and entering your API key.

    2. You can use the interactive API documentation to run the API methods on your Orchestrator.

In this section: