REST API
Fetch data and automate your workflows with the Security Compliance Management 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 Security Compliance Management 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 Security Compliance
Management server hostname. Security Compliance Management 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 Security Compliance Management. This tutorial guides you through running an ad-hoc scan in Security Compliance Management using the API. -
Extract Compliance results using the Security Compliance Management API
If you have a personal API access token and the correct user permissions, you can use the Security Compliance Management API to extract compliance results from Puppet Security Compliance Management and share those results with your organization’s other third party tooling. -
Export Security Compliance Management data using the SCM API
If you have a personal API access token and the correct user permissions, you can use the SCM Exports API to create, retrieve, download, and delete exports of data from Security Compliance Management. -
Synchronize inventory with Puppet Enterprise using the Security Compliance Management API
If you have a personal API access token and the correct user permissions, you can use the Security Compliance Management Inventory API to initiate a Puppet Enterprise inventory sync.