List Scans

Request

GET

https://appsec.sourcecraft.tech/v1/scans

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: `\S` Example: `0199140f-4343-7c06-a7e3-b835c305b629`
pageSize	Type: integer Pagination page size, maximum 250, default: 50 scans Default: `50` Min value: `1` Max value: `250`
pageToken	Type: string Page token for cursor-based pagination. Omit for first page, use nextPageToken (from the response) to request subsequent pages. Default: `` Example: `3f5d8c9a1e4afj4bv44b453jg`
status	All of 2 types Type: ScanStatus1 Enum: `SCAN_STATUS_UNSPECIFIED`, `NO_RUNS_YET`, `RUNNING`, `FINISHED`, `FAILED`, `UNRECOGNIZED` Type: unknown Default: `FINISHED` Example: ``

ScanStatus1

Type: string

Enum: SCAN_STATUS_UNSPECIFIED, NO_RUNS_YET, RUNNING, FINISHED, FAILED, UNRECOGNIZED

Responses

200 OK

Body

application/json

{
  "data": [
    {
      "id": 0,
      "uuid": "example",
      "status": 0,
      "commitHash": "example",
      "timeStarted": 0,
      "timeFinished": 0,
      "isLatest": true,
      "gitReferenceName": "example",
      "pullRequestId": "example",
      "newDelta": 0,
      "closedDelta": 0,
      "totalDefectGroups": 0,
      "foundDefectGroups": 0,
      "openDefectGroups": 0,
      "scanType": "example",
      "expectedReportCount": 0,
      "receivedReportCount": 0,
      "origin": "example"
    }
  ],
  "nextPageToken": "example",
  "totalSize": 0,
  "listRevision": "example"
}

Name	Description
data	Type: ScanSummaryDto[] Example `[ { "id": 0, "uuid": "example", "status": 0, "commitHash": "example", "timeStarted": 0, "timeFinished": 0, "isLatest": true, "gitReferenceName": "example", "pullRequestId": "example", "newDelta": 0, "closedDelta": 0, "totalDefectGroups": 0, "foundDefectGroups": 0, "openDefectGroups": 0, "scanType": "example", "expectedReportCount": 0, "receivedReportCount": 0, "origin": "example" } ]`
nextPageToken	Type: string Example: `example`
totalSize	Type: integer
listRevision	Type: string \| null Example: `example`

ScanSummaryDto

Name	Description
commitHash	Type: string Example: `example`
expectedReportCount	Type: integer
gitReferenceName	Type: string \| null Example: `example`
id	Type: integer
isLatest	Type: boolean
origin	Type: string Example: `example`
pullRequestId	Type: string \| null Example: `example`
receivedReportCount	Type: integer
scanType	Type: string Example: `example`
status	Type: integer
timeFinished	Type: integer \| null
timeStarted	Type: integer \| null
uuid	Type: string Example: `example`
closedDelta	Type: integer \| null
foundDefectGroups	Type: integer \| null
newDelta	Type: integer \| null
openDefectGroups	Type: integer \| null
totalDefectGroups	Type: integer \| null

Example

{
  "id": 0,
  "uuid": "example",
  "status": 0,
  "commitHash": "example",
  "timeStarted": 0,
  "timeFinished": 0,
  "isLatest": true,
  "gitReferenceName": "example",
  "pullRequestId": "example",
  "newDelta": 0,
  "closedDelta": 0,
  "totalDefectGroups": 0,
  "foundDefectGroups": 0,
  "openDefectGroups": 0,
  "scanType": "example",
  "expectedReportCount": 0,
  "receivedReportCount": 0,
  "origin": "example"
}

Was the article helpful?

Overview

Get Latest Scan