REST API

Description of the endpoints that make up the hl2 Panorama REST API.


hl2 Panorama provides a REST API respecting the standard methods and status codes of HTTP. We’re also doing our best to provide meaningful endpoints which can be integrated easily into your infrastructure.

OpenAPI Specification

As described before, we strongly believe in standards as a way of communication between us and our customers. That’s why we have chosen to write an OpenAPI descriptor publicly available on GitHub. Here is a quote from the readme of the OpenAPI Specification repository on GitHub.

The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for REST APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.

You can browse the latest version of the hl2 Panorama API descriptor by clicking this link or by browsing the repository.

Found an issue?

As the repository is public you can submit an issue - or even better open a pull request.

Postman

A tool we use extensively at hl2 is Postman. It allows us to manage our hl2 Panorama instances via their REST API through an intuitive interface.

Since version v6.6, it’s now possible to import an OpenAPI v3.0 descriptor via file, url, or by directly entering JSON or YAML as raw text from the Import button within the Postman App (See Postman Supports OpenAPI 3.0). So, you just have to paste https://raw.githubusercontent.com/hl2/hl2-panorama-openapi/master/openapi/spec.json into the import dialog of the Postman App.

and the corresponding collection will be created:

Lifecycle

We will commit ourselves to support the API and maintain backwards compatibility in the future, but we reserve the right to make incompatible changes when necessary. If you experience any issue, drop us an email from the contact page.

What's on this page?