Skip to main content

PingCastle Enterprise API

warning

This API is for PingCastle Enterprise. It isn't a general-purpose API. The --api-endpoint and --api-key options upload reports to a PingCastle Enterprise server, and no other endpoint is supported. PingCastle Community has no web server and doesn't provide an API of its own.

PingCastle.exe can send reports in XML format (encrypted or not) to a PingCastle Enterprise server using the --api-endpoint and --api-key command line options. In this "agent" mode, PingCastle.exe automatically performs scans and sends the reports to the Enterprise web UI. You typically schedule scans using Windows Task Scheduler. For setup steps, see Deploy agents.

https://www.pingcastle.com/wp/wp-content/uploads/2018/09/pingcastle-swagger.webp

API specification​

The Enterprise API specification is available in Swagger format via the Swagger Editor or as a direct download.