Interactive Swagger Documentation

Documentation in the OpenAPI standard is provided along with the Intrexx Administration API. This is displayed by a Swagger UI component. This documentation is interactive, so you can use it to learn about and test the Intrexx Administration API.

For detailed information about Swagger, please visit the following link: https://swagger.io/

Enable Interactive Swagger Documentation

1. Set the "DebugMode" attribute to "true" in the "admin-api.yaml" file.

   You can find the "admin-api.yaml" file at the following path:

   <intrexx-installation-directory>\admin-api\cfg\

                       
   environment:
     …
     …
   debugMode: true
   maxAuthRequestPerIP: 50
                   

2. Restart the Intrexx Administration API.

   For more information, see the section " Launch the Intrexx Administration API."

3. Open the following URL in a browser:

   <Host-URL>:4242/documentation

   Example

   https://localhost:4242/documentation

   If you did not select the default port 4242 when installing the IAA, you must adjust the port in the URL accordingly.