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

# Request package scan

`POST /scan/package`

## Request

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

## Headers

- `X-Auth-Token` string, required

## Request body

- RESTScanPackageReqData
  - `source` string, required
  - `user` string, required
  - `job` string, required
  - `workspace` string, required
  - `function` string, required
  - `region` string, required
  - `application_packages` RESTScanAppPackage[], required
    - `app_name` string, required
    - `module_name` string, required
    - `version` string, required
    - `file_name` string, required

## Response `200`

Success

- RESTScanPkgReportData
  - `report` RESTScanPkgReport, required
    - `verdict` string, required
    - `message` string, required
    - `cvedb_version` string, required
    - `cvedb_create_time` 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[]

---

[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)