Airlock Microgateway API and OperatorConfig reference

Navigation using the hamburger button

The Button - hamburger menu button appears when selecting a topic, e.g. DenyRules, in the left navigation menu. Use it to open the corresponding table of content (TOC).

The TOC is especially useful for orientation on larger content pages, as the content is logically sorted, e.g.:

DenyRules
DenyRules.spec
DenyRules.spec.request
DenyRules.spec.request.builtIn
DenyRules.spec.request.builtIn.exceptions
DenyRules.spec.request.builtIn.exceptions[].blockedData
...

Example:

Airlock Microgateway API reference TOC

Custom Resource usage

The API Reference documentation is enriched with Custom Resource code snippets.

  • Minimal usage is a convenient starting point for creating Custom Resources.
  • MGW API reference - minimal code example
  • Default illustrates the default settings within the Custom Resource if the setting is absent.
  • MGW API reference - default code example