---
title: "Ingest Scan"
method: PUT
path: "/v1/scan"
---

# Ingest Scan

`PUT /v1/scan`

## Request body

- XeolEventPayload
  - `AppConfig` AppConfig, required
    - `project-name` string, required
    - `commit-hash` string, nullable
  - `Matches` Matches[], required
    - `Cycle` Cycle, required
      - `ProductName` string, required
      - `ProductPermalink` string, nullable
      - `ReleaseCycle` string, required
      - `Eol` string, required
      - `LTS` boolean, nullable
      - `EolBool` boolean, nullable
      - `LatestRelease` string, nullable, required
      - `LatestReleaseDate` string, nullable, required
      - `ReleaseDate` string, nullable, required
    - `Package` Package, required
      - `ID` string, nullable
      - `Name` string, required
      - `Version` string, required
      - `Language` string, nullable
      - `Type` string, required
      - `CPEs` CPE[], nullable
        - `Part` string, nullable, required
        - `Vendor` string, nullable, required
        - `Product` string, nullable, required
        - `Version` string, nullable, required
        - `Update` string, nullable, required
        - `Edition` string, nullable, required
        - `SWEdition` string, nullable, required
        - `TargetSW` string, nullable, required
        - `TargetHW` string, nullable, required
        - `Other` string, nullable, required
        - `Language` string, nullable, required
      - `PURL` string, nullable
      - `Upstreams` Upstream[], nullable
        - `Name` string, required
        - `Version` string, required
      - `MetadataType` string, nullable
  - `ImageName` string, required
  - `ImageDigest` string, nullable
  - `ImageVerified` boolean, nullable
  - `Sbom` string, nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/xeol/apis/fastapi.md) · [All operations](https://skmtc.dev/xeol/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/xeol/fastapi/revisions/545d83b42156/schema)