GET /orgs/{orgId}/audit-export/configGet the audit-export config
Org owner/admin only. Returns the masked S3 export config or 404 when not configured.
Auth: Bearer token required
Path parameters
| Name | Type | Description |
|---|---|---|
orgId | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | AuditExportConfig |
401 | Unauthorized | Error |
403 | Forbidden | Error |
404 | Not Found | Error |
POST /orgs/{orgId}/audit-export/configUpsert the audit-export config
Org owner/admin only. Create or update the S3 audit-export configuration.
Auth: Bearer token required
Path parameters
| Name | Type | Description |
|---|---|---|
orgId | string |
Request body (application/json)
| Field | Type | Description |
|---|---|---|
bucket | string | S3 bucket name (required) |
region | string | AWS region (required) |
roleArn | string | IAM role ARN for assume-role (required) |
enabled | boolean | Enable/disable export |
Responses
| Status | Description | Schema |
|---|---|---|
201 | Created | AuditExportConfig |
401 | Unauthorized | Error |
403 | Forbidden | Error |
404 | Not Found | Error |
POST /orgs/{orgId}/audit-export/test-connectionTest the audit-export S3 connection
Org owner/admin only. Performs a write+delete dry-run against the configured/provided bucket.
Auth: Bearer token required
Path parameters
| Name | Type | Description |
|---|---|---|
orgId | string |
Request body (application/json)
| Field | Type | Description |
|---|---|---|
bucket | string | S3 bucket name (required) |
region | string | AWS region (required) |
roleArn | string | IAM role ARN for assume-role (required) |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | AuditExportTestResult |
401 | Unauthorized | Error |
403 | Forbidden | Error |
404 | Not Found | Error |
GET /orgs/{orgId}/audit-export/runsList audit-export runs
Org owner/admin only. Returns recent export batch runs, newest-first.
Auth: Bearer token required
Path parameters
| Name | Type | Description |
|---|---|---|
orgId | string |
Query parameters
| Name | Type | Description |
|---|---|---|
limit | integer | Max results (default 20, max 100) |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | AuditExportRunList |
401 | Unauthorized | Error |
403 | Forbidden | Error |
404 | Not Found | Error |
AuditExportConfig| Field | Type | Description |
|---|---|---|
id | string | (required) |
orgId | string | (required) |
bucket | string | (required) |
region | string | (required) |
roleArnMasked | string | (required) |
enabled | boolean | (required) |
lastTestedAt | string | null | (required) |
lastTestOk | boolean | null | (required) |
lastError | string | null | (required) |
lastExportedAt | string | null | (required) |
createdAt | string | (required) |
updatedAt | string | (required) |
AuditExportRun| Field | Type | Description |
|---|---|---|
id | string | (required) |
orgId | string | (required) |
startedAt | string | (required) |
completedAt | string | null | (required) |
eventCount | integer | (required) |
bytes | integer | (required) |
success | boolean | (required) |
error | string | null | (required) |
s3Key | string | null | (required) |
AuditExportRunListType: AuditExportRun[]
AuditExportTestResult| Field | Type | Description |
|---|---|---|
success | boolean | (required) |
error | string |
Error| Field | Type | Description |
|---|---|---|
error | string | (required) |
code | string |