Skip to main content
The compliance endpoints let you enable frameworks, run assessments against your connected providers, retrieve control-level results, and export reports as PDF or CSV. Supported frameworks include CIS AWS Foundations Benchmark, SOC 2, NIST 800-53, and PCI-DSS. Base path: /api/v1/compliance

GET /compliance/frameworks — list available frameworks

Returns all frameworks available in your account.

Response


POST /compliance/frameworks//enable — enable a framework

Enables a framework for one or more providers.

Request body (optional)

provider_ids
array
IDs of the providers to scope this framework to. If omitted, all connected providers are included.

DELETE /compliance/frameworks//enable — disable a framework

Disables a framework and stops future assessments for it.

POST /compliance/assess — run an assessment

Runs a compliance assessment. If no body is provided, all enabled frameworks run against all providers.

Request body (optional)

framework_id
string
Run only this framework.
provider_id
integer
Scope to a specific provider.

Response 202


GET /compliance/assessments — list assessments

Returns past assessments.

Query parameters

framework_id
string
Filter by framework.
provider_id
integer
Filter by provider.
page
integer
default:"1"
Page number.
per_page
integer
default:"20"
Results per page.

GET /compliance/assessments/ — get assessment results

Returns the full assessment with control-level results and failed resources.

Response

score
number
A value between 0 and 1 representing the percentage of controls that passed.

GET /compliance/assessments//export — export assessment report

Downloads the assessment as a PDF or CSV file.

Query parameters

format
string
required
Export format: pdf or csv.
The response uses the appropriate Content-Type header: application/pdf or text/csv.