Installation Keys
  • 26 Nov 2023
  • 1 Minute to read
  • Contributors
  • Dark

Installation Keys

  • Dark

Article Summary

Installation keys are Base64-encoded strings provided to Sensors and Adapters in order to associate them with the correct Organization. Installation keys are created per-organization and offer a way to label and control your deployment population.

There are four components of an installation key:

  • Organization ID (OID): The Organization ID that this key should enroll into.
  • Installer ID (IID): Installer ID that is generated and associated with every Installation Key.
  • Tags: A list of Tags automatically applied to sensors enrolling with the key.
  • Description: The description used to help you differentiate uses of various keys.


Installation keys can be managed on the Sensors > Installation Keys page in the web app.

On this page, under the Connectivity section, you will see the various URLs associated with Sensor and Adapter connectivity.

Pinned Certificates

Typically, Sensors require access over port 443 and use pinned SSL certificates. This is the default deployment option, and does not support traffic interception.

If you need to install sensors without pinned certificates, an installation key must be created with a specific flag. This must be done via the REST API, by setting the use_public_root_ca flag to true.

More details can be found here.

Use of Tags

Generally speaking, we use at least one Installation Key per organization. Then we use different keys to help differentiate parts of our infrastructure. For example, you may create a key with Tag "server" that you will use to install on your servers, a key with "vip" for executives in your organization, or a key with "sales" for the sales department, etc. This way you can use the tags on various sensors to figure out different detection and response rules for different types of hosts on your infrastructure.

Was this article helpful?

What's Next