---
title: "GET /v1/upgrade-report"
method: GET
path: "/v1/upgrade-report"
tags: ["migration"]
---

# GET /v1/upgrade-report

`GET /v1/upgrade-report`

## Request

- Base URL: `https://api.pkgseek.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.pkgseek.com/v1/upgrade-report`
- Auth: none declared

## Query parameters

- `distro` string, required
- `from` string, required
- `to` string, required
- `q` string
- `change` string
- `limit` integer
- `offset` integer

## Response `200`

Release-wide package, dependency, file and CVE differences

- UpgradeReport
  - `filtered_total` integer, required
  - `items` UpgradeChange[], required
    - `change` string, required: `added`, `removed`, `upgraded`, `downgraded`, `changed`, or `unchanged`.
    - `config_files_added` string[], required
    - `config_files_removed` string[], required
    - `cves_introduced` string[], required
    - `cves_resolved` string[], required
    - `dependencies_added` string[], required
    - `dependencies_removed` string[], required
    - `name` string, required
    - `replacement_candidates` string[], required: Target packages declaring `Provides: <removed-name>`.
    - `services_added` string[], required
    - `services_removed` string[], required
    - `source_package` MigrationPackage: One representative package build at either side of a migration.
      - `name` string, required
      - `release` string, required
      - `repo` string, required
      - `source` string, required
      - `summary` string, required
      - `version` string, required
    - `target_package` MigrationPackage: One representative package build at either side of a migration.
      - `name` string, required
      - `release` string, required
      - `repo` string, required
      - `source` string, required
      - `summary` string, required
      - `version` string, required
  - `source` MigrationCoordinate, required
    - `distro` string, required
    - `release` string, required
  - `source_cve_scanned` boolean, required
  - `summary` UpgradeSummary, required
    - `added` integer, required
    - `removed` integer, required
    - `source_packages` integer, required
    - `target_packages` integer, required
    - `unchanged` integer, required
    - `version_changed` integer, required
  - `target` MigrationCoordinate, required
    - `distro` string, required
    - `release` string, required
  - `target_cve_scanned` boolean, required

## Other responses

- `400`: Invalid or unindexed release coordinate

---

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