Skip to content

How to Create an API Key

To create a new API Key:

  1. Log in to your account.
  2. From the main dashboard, navigate to Settings > Application Keys.
  3. Click + Add Key. The Add Application Key form opens.
  4. In the Key Name text box, enter the desired name for the key.

  5. In the Role dropdown, choose what the key is allowed to reach:

    • User — the default. Read access to the platform, plus the write actions a user can perform.
    • Viewer — read-only access to the platform. Choose this for a key that only queries data, such as a reporting client or the MCP server.
    • Endpoint — registers devices with Endpoint Protection and grants no other access, including no read access to the platform. Offered only on accounts where Endpoint Protection is enabled. The Endpoint Protection Installation page is a shortcut to create one: the deployment tokens it creates are Endpoint keys.

    Keys with the Data Upload role are created and managed by Boost Security for integrations such as Zero Touch Provisioning, and cannot be created from this form.

    A key's role decides what it can reach, so pick the narrowest role that covers what the key is for. See API Key Roles for what each role can and cannot do.

    Choosing the role of an API key

  6. In the Asset Group dropdown, associate the key with All Assets, the default, which gives the key access to every asset, or with one of your asset groups. A key associated with an asset group can only access the data of the assets in that group.

    Choosing the asset group of an API key

  7. In the Expiration dropdown, choose how long the key remains valid: Never, 30 days, 60 days, 90 days or 1 year. A duration is counted from the moment the key is created. The default, Never, creates a key that does not expire.

  8. Click Save.

Once the key is created, a new entry is displayed with the key name selected and the clipboard icon. The clipboard enables copying the API Key value so you can configure your scanner or the GraphQL API client.

Created Application Key

Note

This is the only time you can copy the API key value. On your next visit to the Application Keys view, you will see the application key name, its expiration and its date of creation, but you won't be able to retrieve the key value.

The expiration of a key can be changed after the key is created, including a key that was created with no expiration. See Managing API Key Expiration.