Organisations
Download a compliance evidence pack
For a framework and a range of at most 400 days: the controls, the diagrams mapped to them, every check on a default branch, the drift episodes and their pull requests, the approval decisions, the hand-drawn diagrams and the methodology.
GET
/orgs/{org}/evidence/exportTL;DR
| Question | Answer |
|---|---|
| What does it do? | Download a compliance evidence pack. |
| What does it take? | org in the path, and framework, from, to, format, paper, open in the query string. |
| What does it return? | Status 200 with a body of type string. |
| What can go wrong? | 400 the query or the range is not valid (evidence.range_invalid); 401 not signed in; 403 a member or a reader (orgs.forbidden), or a plan without compliance evidence (plan.compliance_evidence_not_included); 404 no such organisation, or the caller is not a member of it; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
For a framework and a range of at most 400 days: the controls, the diagrams mapped to them, every check on a default branch, the drift episodes and their pull requests, the approval decisions, the hand-drawn diagrams and the methodology. As an HTML report to print as PDF, JSON, or CSV. The owner and admins, on Enterprise. Audited.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
framework | "pci-dss" | "soc2" | "iso27001" | "nist-800-53" | "all" | yes | One framework, or all. |
from | string | yes | The first day, YYYY-MM-DD, UTC. |
to | string | yes | The last day, YYYY-MM-DD, UTC, at most 400 days after from. |
format | "html" | "json" | "checks.csv" | "episodes.csv" | "diagrams.csv" | yes | html (the report to print as PDF), json (the pack), or one CSV table. |
paper | "a4" | "letter" | no | The report's paper: a4 or letter. Only the report reads it. |
open | "true" | "false" | no | true opens the report in the browser to print, rather than downloading it. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The file, as an attachment. | string |
| 400 | The query or the range is not valid (evidence.range_invalid). | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | A member or a reader (orgs.forbidden), or a plan without compliance evidence (plan.compliance_evidence_not_included). | ErrorResponse |
| 404 | No such organisation, or the caller is not a member of it. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type string.
| Field | Type | Required | Description |
|---|
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |