topic Re: Python API for Compliance Reports in Prisma Cloud Discussions

Python API for Compliance Reports

JBox — Wed, 02 Sep 2020 17:16:44 GMT

Hi all,

I'd like to create, read, update and/or delete Compliance Reports via the API but there's no documentation on compliance reports in the REST API documentation. It was confirmed that the API does support CRUD for compliance reports and that a ticket for the inclusion of the information in the documentation has been opened, but I was wondering if in the mean-time anyone has the information for Compliance Reports CRUD via the API in Python.

Thanks!

Re: Python API for Compliance Reports

jrieger — Fri, 21 Jun 2019 04:05:45 GMT

The compliance API's are documented under "Compliance Standards" in the API documentation. Updating a policy to add a control to a particular policy is done using the "Policy" API's.

My tools that I use for this purpose:

Main link - https://github.com/jdrieger/rl-toolbox

Example tool to copy a compliance report - https://github.com/jdrieger/rl-toolbox/blob/master/rl-compliance-copy.py

The main link has the general instructions for the use, but basically, the various example scripts call the rl_lib_general.py and rl_lib_api.py libraries for the API calls.

That should be fully functional and do everything you asked about (except the delete).

Re: Python API for Compliance Reports

jrieger — Fri, 21 Jun 2019 04:18:04 GMT

I just realized you might mean the Complaince - Reports tab. In that case, please see the tool created by Eddie:

https://github.com/ebeuerle/compliance_report_email

That is an example of downloading a report and sending it.

If you want to actually post the creation of PDF reports, that uses the "https://api.redlock.io/report" API.

Payload for the post object is formatted like:

{"cloudType":"azure","name":"test","target":{"accounts":["**Account ID's list**"],"regions":[],"timeRange":{"type":"to_now","value":"epoch"}},"type":"HIPAA"}

You can see other examples in the Chrome - Developer Tools - Network tab. Not sure why this particular API was not documented, but the UI uses it for report creation and the URL and example post objects can be pulled from there for the time being.