---
title: "Scan repository"
method: POST
path: "/scan/repository"
tags: ["Scan"]
---

# Scan repository

`POST /scan/repository`

## Request

- Base URL: `/v1` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/v1/scan/repository`
- Auth: none declared. Required headers: `X-Auth-Token`
- TypeScript: <https://skmtc.dev/neuvector/apis/neuvector-api/docs/scan/repository/post.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `X-Auth-Token` string, required

## Request body

- RESTScanRepoReqData
  - `request` RESTScanRepoReq, required
    - `metadata` RESTScanMeta, required
      - `source` string, required
      - `user` string, required
      - `job` string, required
      - `workspace` string, required
      - `function` string, required
      - `region` string, required
    - `registry` string, required
    - `username` string
    - `password` string
    - `repository` string, required
    - `tag` string, required
    - `scan_layers` boolean, required
    - `base_image` string, required

## Response `200`

Success

- RESTScanRepoReportData
  - `report` RESTScanRepoReport, required
    - `verdict` string
    - `image_id` string, required
    - `registry` string, required
    - `repository` string, required
    - `tag` string, required
    - `digest` string, required
    - `size` integer, required
    - `author` string, required
    - `base_os` string, required
    - `cvedb_version` string, required
    - `cvedb_create_time` string, required
    - `layers` RESTScanLayer[], required
      - `digest` string, required
      - `cmds` string, required
      - `vulnerabilities` RESTVulnerability[], required
        - `name` string, required
        - `score` number, required
        - `severity` string, required
        - `vectors` string, required
        - `description` string, required
        - `package_name` string, required
        - `package_version` string, required
        - `fixed_version` string, required
        - `link` string, required
        - `score_v3` number, required
        - `vectors_v3` string, required
        - `published_timestamp` integer, required
        - `last_modified_timestamp` integer, required
        - `cpes` string[]
        - `cves` string[]
        - `feed_rating` string, required
        - `in_base_image` boolean, required
        - `tags` string[]
      - `size` integer, required
    - `vulnerabilities` RESTVulnerability[], required
      - `name` string, required
      - `score` number, required
      - `severity` string, required
      - `vectors` string, required
      - `description` string, required
      - `package_name` string, required
      - `package_version` string, required
      - `fixed_version` string, required
      - `link` string, required
      - `score_v3` number, required
      - `vectors_v3` string, required
      - `published_timestamp` integer, required
      - `last_modified_timestamp` integer, required
      - `cpes` string[]
      - `cves` string[]
      - `feed_rating` string, required
      - `in_base_image` boolean, required
      - `tags` string[]
    - `modules` RESTScanModule[], required
      - `name` string, required
      - `version` string, required
      - `source` string, required
      - `cves` RESTModuleCve[]
        - `name` string, required
        - `status` string, required
      - `cpes` string[]
    - `envs` string[], required
    - `labels` object, required
      - `key` string[]
      - `value` string

---

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