Using the Comply API
The Comply API allows you to automate actions, retrieve Comply data, and share Comply data with other groups and tooling. To use the API, you first must create a personal access token, after which you can access API endpoints.
Puppet’s open & integrated approach ensures data sharing with enterprise tools (Such as risk management, systems of records etc.), improves productivity and cross-team collaboration leveraging the same data to ensure transparency.
-
Create and manage personal access tokens as a user
As a Comply user, you can create a personal access token for yourself from your user profile in the Comply UI. The endpoints you can access with your token are dependent on your user role’s permissions at the time you call the Comply API. -
Manage personal access tokens as an admin
As a Comply admin, you can view details of personal access tokens created by all Comply users. You can revoke tokens on behalf of other Comply users, but you cannot create a token for another user. -
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.