Getting Started with the Enlighten API

The Enlighten API allows access to system performance data and alerts. To get started using the API with a system, there are two steps:

  1. The system owner must grant API access to their system
  2. The API user must generate an API key

Granting API Access to a system

System owners control API access to their system(s) via the Enlighten system settings page. By default, new systems are API enabled and no action is required.

To change your system’s API accessibility:

1) Click on the settings link at the top of your system view page.

2) On the access section of the settings page, click the API Access checkbox

Generating an API Key

To access system data, an API user must have an API key. Any Enlighten user can generate an API key. Once you have the API key, you can then use the API to query on any site to which you have acces and which has opted in for API use.

Initial generation of an API key requires acknowledgment of the API terms and conditions. To generate an API key for your Enlighten account:

1) Click on the Account tab at the top of the page.

2) On the API Access section of the Account page, agree to the API terms and conditions and click “generate API key.”

3) An API key will be displayed on the page, this is the key that your software should include in all API requests.