Start generating a PDF or SARIF report
Starts asynchronous report generation for a repository scan (the latest scan when scanUuid is omitted). format selects PDF (default) or SARIF; for SARIF, engineType selects the combined report (UNSPECIFIED, default) or a single engine (SECRETS/SCA/SAST/DAST). Returns a long-running operation to poll via GET /v1/reports/operations/{operationUuid}. If a report already exists for the slice, a completed operation referencing it is returned without regeneration; if generation is already running, the in-flight operation is returned.
Request
POST
https://appsec.sourcecraft.tech/v1/reports/generate
Query parameters
|
Name |
Description |
|
engineType |
Type: string | null For SARIF: engine slice to generate — UNSPECIFIED (default) for the combined report, or SECRETS/SCA/SAST/DAST for a per-engine report. Ignored for PDF. Example: `` |
|
format |
Type: string | null Report format: PDF (default) or SARIF. Example: `` |
|
gitRepo |
Type: string Repository identifier. Accepts either internal repository ID (e.g., 88769874964302633) or public UUID (e.g., 0199140f-4343-7c06-a7e3-b835c305b629). These values can be obtained from the getRepo API (fields: id and uuid). Pattern: Example: |
|
scanUuid |
Type: string | null UUID of the scan to generate the report for; if omitted, the latest scan is used. Example: |
Responses
200 OK
OK
Body
application/json
{
"operationUuid": "example",
"status": "IN_PROGRESS",
"done": true,
"reportUuid": "example",
"scanUuid": "example",
"format": "example",
"engineType": "example"
}
|
Name |
Description |
|
done |
Type: boolean |
|
operationUuid |
Type: string Example: |
|
reportUuid |
Type: string | null Example: |
|
status |
Type: OperationStatus Enum: |
|
engineType |
Type: string | null Example: |
|
format |
Type: string | null Example: |
|
scanUuid |
Type: string | null Example: |
OperationStatus
Type: string
Enum: IN_PROGRESS, COMPLETED, FAILED