View the API documentation

The documentation for PowerServer Web APIs is formatted using the OpenAPI Specification (formerly Swagger Specification). Each API is described with the operations (GET and POST) and the operation parameters; and developers can easily try out and adopt the API.

The PowerServer Web APIs here mainly refers to the management APIs in the ServerAPIs project > Controllers folder.

  • ApplicationController.cs: This file provides APIs for dynamically adding, modifying or removing the application settings.

  • ConnectionController.cs: This file provides APIs for dynamically adding, modifying or removing the database connections such as cache or cache group.

  • LicenseController.cs: This file provides APIs for dynamically accessing the license information.

  • SessionController.cs: This file provides APIs for getting all user sessions or killing a particular user session. For more information, see Get/Kill user sessions.

  • StatisticsController.cs: This file provides APIs for getting statistics of the request and transaction.

  • TransactionController.cs: This file provides APIs for getting all transactions or rolling back a particular transaction.

To view the API documentation, run the ServerAPIs project (by clicking Run in the PowerServer C# solution).

The Swagger UI for the API documentation will be launched automatically in the Web browser. However, the Swagger UI may not be successfully loaded until the ServerAPIs project completes all the startup process. You may see Swagger UI refresh a few times before the API documentation is successfully loaded; or you may need to refresh the browser to load the API documentation.


By expanding each API, you can view the details of the API and try out the API (by clicking the Try it out button on the top right corner).

For code examples of calling the API in PowerScript, refer to Get/Kill user sessions.