Get the status of a report-generation operation
Polls a report-generation operation started by POST /v1/reports/generate. Once done is true with status COMPLETED, download the report via GET /v1/reports/presigned-url.
Request
GET
https://appsec.sourcecraft.tech/v1/reports/operations/{operationUuid}
Path parameters
|
Name |
Description |
|
operationUuid |
Type: string UUID of the report-generation operation Example: `` |
Query parameters
|
Name |
Description |
|
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: |
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