Skip to main content
POST
Create file audit report

Authorizations

x-api-key
string
header
required

ROOTKey API key. A test key works on your organization's test data and a live key on its live data; both are used with the same API.

Headers

X-RootKey-Organization
string

The organization a personal access token acts in: the id of one of the organizations that GET /organizations lists. Required with a personal access token on every endpoint that works inside an organization; without it the request gets organization_header_required. Ignored with an API key, which belongs to exactly one organization.

x-test-mode
enum<string>
default:false

Whether a personal access token works on live data (false, the default) or on test data (true). Only this header decides, never a query string or a body field. An API key is itself a test or a live key and works on that data.

Available options:
true,
false

Path Parameters

fileId
string
required

Body

application/json
framework
enum<string>
default:NIS2
Available options:
NIS2,
DORA
periodStart
string<date-time>

Reporting period start (defaults to file createdAt)

periodEnd
string<date-time>

Reporting period end (defaults to now)

Response

Report generation job accepted

reportId
string
required

ID of the created compliance report

Example:

"cmpr_abc123"

status
enum<string>
required

Initial status; the report is processed asynchronously

Available options:
PENDING