skip to main content
Corticon Server: Integration & Deployment Guide : Corticon API reference : REST Management API : Using the REST API Swagger documentation

Try Corticon Now
Using the REST API Swagger documentation
Many of the execute and management REST API methods in a Corticon Server WAR file can be exposed in Swagger, the popular OpenAPI Specification tool for describing, producing, consuming, and visualizing RESTful Web services. Swagger is built-in to every Corticon Server WAR file.
You can use Swagger through BASIC authentication and HTTPS connections.
Note: Get more information about Swagger at

Accessing Swagger on a Corticon Server for Java

To access Swagger and the exposed RESTful methods, enter the following URL into a browser on a machine where Corticon Server is installed and running:
where the URL for typical local installation using HTTP is:

Adjusting Swagger access for custom ports and contexts

If you want to specify a preferred port or a context other than axis, you need to adjust some Swagger configurations.
To use a different port, for example for secure HTTP on port 8851:
1. Edit the file:
2. Edit the url line to:
url = "https://localhost:8851/axis/corticon/swagger.json";
To use a different context, for example Java_UAT:
1. Stop the server.
2. Edit the file:
3. Edit the url line to:
url = "https://localhost:8851/Java_UAT/corticon/swagger.json";
4. Edit the file:
5. Edit the swagger.api.basepath parameter value to:
6. Restart the server.

Disabling Swagger on a Server

To disable Swagger on a Server, edit its web.xml file to add comment markers as shown:
<servlet-name>Corticon REST Service</servlet-name>
<!-- Swagger documentation for the REST APIs -->
<!-- disable Swagger
<!-- End of Swagger documentation for the REST APIs -->

<!-- Swagger Rest API documentation -->
<!-- disable Swagger
<!-- Change this if you deployed you server in a different location -->
When you restart the server, access to Swagger on the Server is disabled. Clear the comment delimiters to again enable Swagger on the server.