REST API Documentation
Accessing the Swagger Page
The CONNX REST API is documented with Swagger. The swagger page can be found at https://<CONNX REST Server>:<Port>/swagger where <CONNX REST Server> is the name of the server where the CONNX REST Server is installed and <Port> is the port number it is listening on. Port 9500 is the default.
Swagger supports a Try It Out feature that can be used to test the APIs. To use the Try It Out feature for any of the APIs, you first need to log in. Below is an example of how to log in using the Try It Out feature in swagger:
Using the Try It Out Feature
1. Navigate to the swagger page and click Security to expand the list of APIs.
2. Select /api/srv/security/login POST.
3. In the Parameters section, click on the yellow Example Value box. This will populate the loginInfo with correctly formatted input parameters. For username, put in a valid Windows Active Directory user name. Swagger requires an escape for the backslash character so if you enter the user name in the form of domain\user, you will need to enter it as domain\\user when using swagger.
4. Click Try it Out!
Swagger will do a POST and you will get a response in the Response Body.
5. Copy the access token into your copy buffer. You will need to select the entire string as it scrolls off the screen to the right. Do not copy the double quotes.
6. Enter bearer <access_token_from_step_5> from the response body in the api_key text box that is located in the top banner.
7. Press the Enter key.
This access token will be used on all subsequent calls to the REST server.