The chat responses are generated using Generative AI technology for intuitive search and may not be entirely accurate. They are not intended as professional advice. For full details, including our use rights, privacy practices and potential export control restrictions, please refer to our Generative AI Service Terms of Use and Generative AI Service Privacy Information. As this is a test version, please let us know if something irritating comes up. Like you get recommended a chocolate fudge ice cream instead of an energy managing application. If that occurs, please use the feedback button in our contact form!
Skip to content
Polarion

The Polarion REST API gives external applications an integration layer with Polarion that gives you greater control over the information you use in both Polarion and the applications you use daily.

Enable REST API¶

Polarion's REST API is disabled by default, but administrators can enable it by setting the following property in the polarion.properties file:

com.siemens.polarion.rest.enabled=true

(Optional) Enable the Swagger UI¶

The Swagger UI is generated automatically from Polarion's OpenAPI implementation.

When enabled, your development team or end consumers can view and interact with API resources without needing any implementation logic in place.

Swagger UI

To enable Swagger UI, set the following property to true in the polarion.properties file:

com.siemens.polarion.rest.swaggerUi.enabled=true

Note

  • Both properties are system-level properties so you must set them in the polarion.properties file before starting Polarion.
  • They are both disabled by default to give you more control over security.
  • com.siemens.polarion.rest.enabled must be set to true for com.siemens.polarion.rest.swaggerUi.enabled to have an effect.