Swagger

Swagger is used to connect to the PrismUI API. By visiting the docs URL, you can view the available commands for the API.

You can view the available commands by going to the below URL. Replace {machinename} with the IP address or DNS name of the computer on which the API service is running.

Unsecured connection:

http://{machinename}:8080/docs

Secured connection:

https://{machinename}:8612/docs

Commands

To view information about the commands listed on the http://{machinename}:8080/docs page, click the command. It's Parameters, Responses and Codes will be displayed.

To execute the command, click Try it out, then Execute. Once the command has been run, the returned information will be displayed in the Responses section.

Note: The returned data in the Response Body will be in JSON.

Models

You can see the object Models for the API in the Models section.

Expanding an object will display it's properties and their data types.