Skip to main content

Authentication

To authenticate your requests, use this code:

curl \
  --header 'Authorization: Bearer API_KEY'

Any request made to the HL2 Panorama API must include this Authorization header, containing a valid API key for your organization.

API keys are created through the HL2 Panorama web interface.

The registered user creating the organization through the web platform is granted the “owner” permission on the organization, and can in turn grant this permission to any other registered user they add to the organization. Any organization owner can then create API keys using the organization’s settings page.

Several different keys may be created, or the same key can be shared by several users of the API. Be aware, though, that using the same key for several concurrent processes could induce rate limiting issues, just as firing many requests in rapid succession in any single process could. For more on this, see the “Rate limiting” section on the “Request Limits” page.

Keys can be revoked independently or all at once by an organization owner at any time through the interface.

If you don’t have an API key for your organization, either:

  • ask for one from one of the organization owners
  • generate one yourself through the interface if you have the owner permission on the organization
  • create the organization in the system if it does not exist yet, and then generate the key or keys

As a rule of thumb, each request should always include at least :

  • an Authorization header including an API key, in the format above
  • a method, like --request GET,
  • a URL, like --url 'https://api.hl2.com/panorama/v1/account'

When the call examples in the rest of this documentation omit one or several of the above, it is assumed you will add them, with the appropriate values.

Make sure to replace API_KEY with a valid API key for your organization in the Authorization header.