OpenAPI (also known as Swagger), is a specification for describing APIs. It provides a standard, language-agnostic way to describe the functionality of an API, as well as a way to generate documentation, code samples and presets automatically. The OpenAPI specification is a JSON file that contains information about the API, including its endpoints, parameters, and responses.
We provide OpenAPI specifications to download for the Service and Session endpoints on this page.
In addition to generating documentation and code samples, the OpenAPI specifications can also be ingested into tools like Node-RED when controlling Designer using the API.
Interactive documentation is included with the Designer installation, it can be found in d3Manager by navigating to Help > Open API Documentation.
You can also access the documentation directly by opening a web browser and navigating to the IP address or hostname of any machine with disguise installed. For example, you can go to http://127.0.0.1 to access the documentation on the local machine.
