REST API
Fetch data and automate your workflows with the Comply REST API. Use the API to promote pipelines based on your own criteria and automate workspace setup to make onboarding new users more streamlined.
The Comply REST API uses the OpenAPI standard, which
you can refer to at any point at https://<COMPLY-HOSTNAME>/openapi.json, where
COMPLY-HOSTNAME
is your organization’s Comply server hostname. Comply uses version
3.0.1 of the standard.
-
REST API tutorial
Learn how to interact with the diverse set of endpoints and harness the power of REST architecture in integrating with and extending the functionality of Comply. This tutorial guides you through running an ad-hoc scan in Comply using the API. -
Extract Compliance results using the Comply API
If you have a personal API access token and the correct user permissions, you can use the Comply API to extract compliance results from Puppet Comply and share those results with your organization’s other third party tooling. -
Export Comply data using the Comply API
If you have a personal API access token and the correct user permissions, you can use the Comply Exports API to create, retrieve, download, and delete exports of data from Comply. -
Synchronize inventory with Puppet Enterprise using the Comply API
If you have a personal API access token and the correct user permissions, you can use the Comply Inventory API to initiate a PE inventory sync.