---
title: "Get a scan"
method: GET
path: "/scans/{id}"
---

# Get a scan

`GET /scans/{id}`

## Request

- Base URL: `https://app.gecko.security/api/v1`
- URL: `https://app.gecko.security/api/v1/scans/{id}`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

## Path parameters

- `id` string, required

## Response `200`

Success

- Scan
  - `object` 'scan', required
  - `id` string, uuid, required
  - `name` string, required
  - `status` string, nullable, required
  - `is_done` boolean, required
  - `progress` integer, nullable, required
  - `programming_language` string, nullable, required
  - `kind` 'main' | 'pr' | 'fix', required
  - `branch` string, nullable, required
  - `commit_sha` string, nullable, required
  - `pull_request_number` integer, nullable, required
  - `repository` string, nullable, required
  - `model` string, nullable, required
  - `vulnerability_counts` object, required
    - `critical` integer, required
    - `high` integer, required
    - `medium` integer, required
    - `low` integer, required
    - `total` integer, required
  - `created_at` string, required
  - `ended_at` string, nullable, required

## Other responses

- `401`: Authentication error
- `403`: Authorization error
- `404`: Not found
- `429`: Rate limited

---

[API](https://skmtc.dev/gecko/apis/gecko-security-api.md) - [All operations](https://skmtc.dev/gecko/apis/gecko-security-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gecko/apis/gecko-security-api/revisions/9da49dae8b07?raw)