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

<div class="openapi">

# List Defect Groups By Link

<!-- 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/defect-groups/by-link
```

</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}
||
||

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

Identifier of the link as it is stored: a platform ID for SOURCECRAFT_ISSUE and SOURCECRAFT_PR, an HTTPS URL for the other types

_Pattern:_{.json-schema-reset .json-schema-assertion} `\S`

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

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

Link type to search by: EXTERNAL_URL, SOURCECRAFT_ISSUE, SOURCECRAFT_PR or YA_TRACKER

_Enum:_{.json-schema-reset .json-schema-value} `EXTERNAL_URL`, `SOURCECRAFT_ISSUE`, `SOURCECRAFT_PR`, `YA_TRACKER`
{.table-cell}
||
||

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

Pagination page size, maximum 250, default: 50 defect groups

_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}
||
|#{.json-schema-properties}

<div class="openapi-entity">

### LinkType {#entity-LinkType}

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `EXTERNAL_URL`, `SOURCECRAFT_ISSUE`, `SOURCECRAFT_PR`, `YA_TRACKER`

</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,
      "ruleName": "example",
      "codeBlock": "example",
      "fileName": "example",
      "latestCommit": "example",
      "latestTimeFound": 0,
      "gitRepo": "example",
      "status": 0,
      "severity": 0,
      "cvssScore": 0.5,
      "engine": "example",
      "neuroTriageUuid": "123e4567-e89b-12d3-a456-426614174000",
      "neuroScore": 0,
      "firstCommit": "example",
      "firstTimeFound": 0,
      "uuid": null,
      "ruleId": "example",
      "findingsCount": 0,
      "publicId": 0,
      "fixOperationUuid": null,
      "engineType": 0,
      "startLine": 0,
      "endLine": 0,
      "startColumn": 0,
      "endColumn": 0,
      "links": [
        {
          "type": "EXTERNAL_URL",
          "url": "example"
        }
      ]
    }
  ],
  "nextPageToken": "example",
  "totalSize": 0,
  "listRevision": "example"
}
```

{% endcut %}

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

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

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

```json translate=no
[
  {
    "id": 0,
    "ruleName": "example",
    "codeBlock": "example",
    "fileName": "example",
    "latestCommit": "example",
    "latestTimeFound": 0,
    "gitRepo": "example",
    "status": 0,
    "severity": 0,
    "cvssScore": 0.5,
    "engine": "example",
    "neuroTriageUuid": "123e4567-e89b-12d3-a456-426614174000",
    "neuroScore": 0,
    "firstCommit": "example",
    "firstTimeFound": 0,
    "uuid": null,
    "ruleId": "example",
    "findingsCount": 0,
    "publicId": 0,
    "fixOperationUuid": null,
    "engineType": 0,
    "startLine": 0,
    "endLine": 0,
    "startColumn": 0,
    "endColumn": 0,
    "links": [
      {
        "type": "EXTERNAL_URL",
        "url": "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">

### UUID {#entity-UUID}

**Type**: string&lt;uuid&gt;

_Pattern:_{.json-schema-reset .json-schema-assertion} `[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}`

_Example:_{.json-schema-reset .json-schema-example} `123e4567-e89b-12d3-a456-426614174000`

</div>

<div class="openapi-entity">

### DefectGroupLinkDto {#entity-DefectGroupLinkDto}

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

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

_Enum:_{.json-schema-reset .json-schema-value} `EXTERNAL_URL`, `SOURCECRAFT_ISSUE`, `SOURCECRAFT_PR`, `YA_TRACKER`
{.table-cell}
||
||

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

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

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

```json translate=no
{
  "type": "EXTERNAL_URL",
  "url": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DefectGroupDto {#entity-DefectGroupDto}

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

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

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

_cvssScore_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: number
{.table-cell}
||
||

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

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

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

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

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

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

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

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

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

_id_{.json-schema-reset .json-schema-property .json-schema-required .json-schema-deprecated}_[ ](*Deprecated)_{.openapi-deprecated .openapi-deprecated-compact}
{.table-cell}|
**Type**: integer
{.table-cell}
||
||

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

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

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

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

_neuroTriageUuid_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

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

  _Pattern:_{.json-schema-reset .json-schema-assertion} `[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}`

  _Example:_{.json-schema-reset .json-schema-example} `123e4567-e89b-12d3-a456-426614174000`

- **Type**: null

  _Example:_{.json-schema-reset .json-schema-example} `null`

{% endcut %}

_Example:_{.json-schema-reset .json-schema-example} `123e4567-e89b-12d3-a456-426614174000`
{.table-cell}
||
||

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

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

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

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

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

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

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

_Pattern:_{.json-schema-reset .json-schema-assertion} `[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}`

_Example:_{.json-schema-reset .json-schema-example} `123e4567-e89b-12d3-a456-426614174000`
{.table-cell}
||
||

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

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

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

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

_fixOperationUuid_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

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

  _Pattern:_{.json-schema-reset .json-schema-assertion} `[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}`

  _Example:_{.json-schema-reset .json-schema-example} `123e4567-e89b-12d3-a456-426614174000`

- **Type**: null

  _Example:_{.json-schema-reset .json-schema-example} `null`

{% endcut %}

_Example:_{.json-schema-reset .json-schema-example} `123e4567-e89b-12d3-a456-426614174000`
{.table-cell}
||
||

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

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

```json translate=no
[
  {
    "type": "EXTERNAL_URL",
    "url": "example"
  }
]
```

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

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

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

_startLine_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer
{.table-cell}
||
|#{.json-schema-properties}

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

```json translate=no
{
  "id": 0,
  "ruleName": "example",
  "codeBlock": "example",
  "fileName": "example",
  "latestCommit": "example",
  "latestTimeFound": 0,
  "gitRepo": "example",
  "status": 0,
  "severity": 0,
  "cvssScore": 0.5,
  "engine": "example",
  "neuroTriageUuid": "123e4567-e89b-12d3-a456-426614174000",
  "neuroScore": 0,
  "firstCommit": "example",
  "firstTimeFound": 0,
  "uuid": null,
  "ruleId": "example",
  "findingsCount": 0,
  "publicId": 0,
  "fixOperationUuid": null,
  "engineType": 0,
  "startLine": 0,
  "endLine": 0,
  "startColumn": 0,
  "endColumn": 0,
  "links": [
    {
      "type": "EXTERNAL_URL",
      "url": "example"
    }
  ]
}
```

{% endcut %}

</div>

</div>

</div>

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