REST API based Airlock Gateway configuration and management interface

REST API specification download

The OpenAPI specifications for the Airlock Gateway REST API are downloadable without authentication through the management network interface of the web-based Airlock Gateway Configuration Center.

  • Available formats:
  • JSON format – https://<configuration-center-url>/airlock/rest/v3/api-docs
  • YAML format – https://<configuration-center-url>/airlock/rest/v3/api-docs.yaml
  • Add your configuration center URL in the above URLs to gain access.

The OpenAPI specifications may be enforced using an appropriate mapping on the Airlock Gateway or an Airlock Microgateway. See further information and links below.

Python library on GitHub

An Airlock Gateway REST API python library is available on GitHub for easier use of the REST API. This library is not part of the official Airlock product delivery and Ergon/Airlock does not provide support for it. However, best-effort support may be provided by the contributor of the library.

Before using this library, carefully read the description on the GitHub page for further usage and compatibility information.