---
metadata:
  - name: generator
    content: Diplodoc Platform v5.64.0
alternate:
  - https://sourcecraft.dev/portal/docs/en/sec-api-ref/Scan-Rest-Api/v1scans-get.md
  - https://sourcecraft.dev/portal/docs/ru/sec-api-ref/Scan-Rest-Api/v1scans-get.md
  - href: https://sourcecraft.dev/portal/docs/ru/sec-api-ref/Scan-Rest-Api/v1scans-get.md
    type: text/markdown
    title: Markdown version
  - href: https://sourcecraft.dev/portal/docs/ru/llms.txt?revision=r21725674
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://sourcecraft.dev/portal/docs/ru/llms.txt?revision=r21725674

<div class="openapi">

# List Scans

<!-- markdownlint-disable-file -->

## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-get);margin-bottom: 12px">

<div class="openapi__request">

GET {.openapi__method}
```text translate=no
https://appsec.sourcecraft.tech/v1/scans
```

</div>

</div>

</div>

### Query parameters

#|
|| **Name** | **Description** ||
||

_gitRepo_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**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:_{.json-schema-reset .json-schema-assertion} `\S`

_Example:_{.json-schema-reset .json-schema-example} `0199140f-4343-7c06-a7e3-b835c305b629`
{.table-cell}
||
||

_pageSize_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Pagination page size, maximum 250, default: 50 scans

_Default:_{.json-schema-reset .json-schema-value} `50`

_Min value:_{.json-schema-reset .json-schema-assertion} `1`

_Max value:_{.json-schema-reset .json-schema-assertion} `250`
{.table-cell}
||
||

_pageToken_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Page token for cursor-based pagination. Omit for first page, use nextPageToken (from the response) to request subsequent pages.

_Default:_{.json-schema-reset .json-schema-value} ``

_Example:_{.json-schema-reset .json-schema-example} `3f5d8c9a1e4afj4bv44b453jg`
{.table-cell}
||
||

_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [ScanStatus1](#entity-ScanStatus1)

  _Enum:_{.json-schema-reset .json-schema-value} `SCAN_STATUS_UNSPECIFIED`, `NO_RUNS_YET`, `RUNNING`, `FINISHED`, `FAILED`, `UNRECOGNIZED`

- **Type**: unknown

  _Default:_{.json-schema-reset .json-schema-value} `FINISHED`

{% endcut %}

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
|#{.json-schema-properties}

<div class="openapi-entity">

### ScanStatus1 {#entity-ScanStatus1}

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `SCAN_STATUS_UNSPECIFIED`, `NO_RUNS_YET`, `RUNNING`, `FINISHED`, `FAILED`, `UNRECOGNIZED`

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "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"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_data_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [ScanSummaryDto](#entity-ScanSummaryDto)[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "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"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_nextPageToken_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_totalSize_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer
{.table-cell}
||
||

_listRevision_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### ScanSummaryDto {#entity-ScanSummaryDto}

#|
|| **Name** | **Description** ||
||

_commitHash_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_expectedReportCount_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer
{.table-cell}
||
||

_gitReferenceName_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer
{.table-cell}
||
||

_isLatest_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean
{.table-cell}
||
||

_origin_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_pullRequestId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_receivedReportCount_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer
{.table-cell}
||
||

_scanType_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer
{.table-cell}
||
||

_timeFinished_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer &#124; null
{.table-cell}
||
||

_timeStarted_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer &#124; null
{.table-cell}
||
||

_uuid_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_closedDelta_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer &#124; null
{.table-cell}
||
||

_foundDefectGroups_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer &#124; null
{.table-cell}
||
||

_newDelta_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer &#124; null
{.table-cell}
||
||

_openDefectGroups_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer &#124; null
{.table-cell}
||
||

_totalDefectGroups_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer &#124; null
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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"
}
```

{% endcut %}

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.