Export a framework
Export a framework’s evidence and progress as an audit-ready zip archive.
The archive holds every evidence file uploaded against the framework’s evidence-based rules, a markdown report of the framework’s progress and the status of all its rules (broken down by documentation section when the framework has documents), and CSV manifests of rules and evidence with SHA-256 checksums.
Send projectId to export one project’s compliance with the framework. Omit it for the
workspace-wide view across every project in the framework, including workspace-scoped rules.
The export runs as a background task, so this returns 202 immediately. To collect the archive:
- Poll
GET /background-tasks/{taskId}with the returnedtaskResultIduntilcompleteistrue. - Read
outputs.storageUrioff that task. - Exchange it for a download link at
GET /storage/presigned-url?storageUri=<uri>.
Rate limited to 2 requests per minute per framework. Asking for an export while an identical one is still queued returns that task rather than starting a second one.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your workspace API key. See Find your API key for more information.
Path Parameters
The framework id.
Body
Scope the export to this project. It must belong to the framework.
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Response
Export queued. Poll taskResultUrl for the archive.
The path to poll for this export's status and result. Already /v1-prefixed, so it is relative to the API host rather than to the /v1 base url -- or just pass taskResultId to GET /background-tasks/{taskId}.
"/v1/background-tasks/3fa85f64-5717-4562-b3fc-2c963f66afa6"
The background task id, for GET /background-tasks/{taskId}.
"3fa85f64-5717-4562-b3fc-2c963f66afa6"