---
title: "Info"
method: GET
path: "/cves"
tags: ["This endpoint is tailored for searches based on product name or specific CPE23, allowing you to retrieve relevant CVE information."]
---

# Info

`GET /cves`

Retrieve information about CVEs based on a specified product name or CPE 2.3 identifier.

Parameters:
- `cpe23` (String, Optional): The CPE version 2.3 identifier for CVE information retrieval.
- `product` (String, Optional): The name of the product for CVE information retrieval.
- `count` (Boolean, Default: false): If set to true, this returns only the count of matching CVEs. This will help a
quick overview of how many CVEs are associated with the product or CPE identifier, especially if the total number
exceeds the limit (by default the limit is 1000 but can be adjusted).
- `is_kev` (Boolean, Default: false): If set to true, this returns only CVEs with the `kev` flag set to true.
- `sort_by_epss` (Boolean, Default: false): If set to true, this sorts CVEs by the `epss` score in descending order.
- `skip` (Integer, Default: 0): Number of CVEs to skip in the result set.
- `limit` (Integer, Default: 1000): The maximum number of CVEs to return in a single query. By default, up to 1000
CVEs can be returned, but you can adjust this value based on your specific needs.
- `start_date` (str, optional): Start date for filtering CVEs (inclusive, format YYYY-MM-DDTHH:MM:SS).
- `end_date` (str, optional): End date for filtering CVEs (inclusive, default is current date, format
YYYY-MM-DDTHH:MM:SS).

Returns:
- if `cpe23` and `product` are not specified:
    - Users can use the `skip` and `limit` parameters to paginate through the results effectively.
    - Return: `cves` is a list of newest CVEs based on published time. Please refer to the `CVEs` schema for more
    details.
- if `cpe23` and `product` are specified:
    - Raise a message indicating that you can only specify one of `cpe23` or `product`.
- if `cpe23` is specified:
    - Return: `cves` is a list of CVEs matching the specified cpe23 identifier. Please refer to the `CVEs` schema
    for more details.
- if `product` is specified:
    - Return: `cves` is a list of CVEs matching the specified product name. Please refer to the `CVEs` schema for
    more details.

Use `start_date` and `end_date` to filter CVEs based on published time. If `start_date` is not specified, it
defaults to 00:00:00 on the given date. If `end_date` is not provided, it defaults to the current date and time.

Workflow retrieve all CVE information based on the `count`, `skip` and `limit` parameters when `cpe23` and
`product` are specified:
- Setting `count` is true:
    - The `skip` and `limit` parameters are ignored for this request.
    - Return: `total` is the total number of CVEs matching the specified product name or CPE 2.3 identifier.
    This allows the user to understand the scale of CVEs associated with the product and plan data retrieval
    accordingly.
- Following the retrieval of the `total` count, users can make subsequent requests to fetch the actual CVE data:
    - Setting `count` is false:
        - Users should use the `skip` and `limit` parameters to paginate through the results effectively. This
        approach facilitates the retrieval of all CVEs associated with the specified product in a structured manner.
        - Parameters `skip` and `limit` allow for precise control over the data fetched in each request. By
        incrementing `skip` by `limit` after each request, users can sequentially access all records up
        to the `total` number.
        - Return: `cves` is a list of CVEs matching the specified product name or CPE 2.3 identifier within the
        specified range. This data is returned in accordance with the pagination parameters (`skip` and `limit`)
        set by the user. Please refer to the `CVEs` schema for more details on the structure of returned data.

## Query parameters

- `cpe23` string, nullable — Format required cpe:2.3:part:vendor:product:version
- `product` string, nullable
- `count` boolean
- `is_kev` boolean
- `sort_by_epss` boolean
- `skip` integer
- `limit` integer
- `start_date` string, nullable — Format YYYY-MM-DDTHH:MM:SS, default time is 00:00:00 on the given date
- `end_date` string, nullable — Format YYYY-MM-DDTHH:MM:SS, default is current date and time
- `format` 'json' | 'markdown'

## Response `200`

Successful Response

- union
  - CVEs
    - `cves` CVE[], required — A collection of CVE objects. Each object provides detailed information about a specific Common Vulnerability and Exposure, including its identification, description, scores, and mitigation recommendations.
      - `cve_id` string, required — The unique identifier assigned to a reported vulnerability, adhering to the CVE-YYYY-NNNNN format, which helps in tracking and referencing vulnerabilities systematically.
      - `summary` string, nullable, required — A brief overview of the vulnerability, providing essential information on what it entails, the affected systems, and the potential impact in clear, understandable English.
      - `cvss` number, nullable, required — The Common Vulnerability Scoring System (CVSS) score, newest version, which ranges from 0 to 10, quantifies the severity of the vulnerability based on various factors such as exploitability, impact, and ease of attack. A score of 10 indicates the highest severity.
      - `cvss_version` number, nullable, required — The version of the CVSS used in the cvss field.
      - `cvss_v2` number, nullable, required — The Common Vulnerability Scoring System (CVSS) score version 2, which ranges from 0 to 10, quantifies the severity of the vulnerability based on various factors such as exploitability, impact, and ease of attack. A score of 10 indicates the highest severity.
      - `cvss_v3` number, nullable, required — The Common Vulnerability Scoring System (CVSS) score version 3, which ranges from 0 to 10, quantifies the severity of the vulnerability based on various factors such as exploitability, impact, and ease of attack. A score of 10 indicates the highest severity.
      - `cvss_v4` number, nullable, required — The Common Vulnerability Scoring System (CVSS) score version 4, which ranges from 0 to 10, quantifies the severity of the vulnerability based on various factors such as exploitability, impact, and ease of attack. A score of 10 indicates the highest severity.
      - `epss` number, nullable, required — The Exploit Prediction Scoring System (EPSS) score, a probabilistic measure between 0 and 1 (0 and 100%)., predicts the likelihood of a vulnerability being exploited in the wild within the next 30 days. Scores closer to 1 indicate a higher risk of exploitation.
      - `ranking_epss` number, nullable, required — This score ranks the vulnerability in terms of its EPSS score relative to all other scored vulnerabilities. It shows the proportion of vulnerabilities that have the same or a lower risk of being exploited, with a score closer to 1 indicating a higher relative risk.
      - `kev` boolean, required — A boolean value indicating whether the vulnerability is known to be exploited in the wild, which is crucial for prioritizing patching and mitigation efforts.
      - `propose_action` string, nullable — Suggested actions or mitigation strategies to address the vulnerability, aimed at reducing its impact or eliminating the risk to affected systems.
      - `ransomware_campaign` string, nullable — Indicates if the vulnerability has been exploited in ransomware campaigns, highlighting its significance and potential impact on security posture.
      - `references` string[], required — A list of references providing further details, technical advisories, and mitigation guidance related to the vulnerability, facilitating deeper understanding and research.
      - `vendor` string, nullable, required — Vendor name effected by this CVE
      - `product` string, nullable, required — Product name of vendor effected by this CVE
      - `version` string, nullable, required — Version of product effected by this CVE
      - `published_time` string, date-time, nullable, required — The date and time when the vulnerability was published, in the format YYYY-MM-DDTHH:MM:SS, with UTC time zone.
      - `euvd` EUVDInfo
        - `id` string, nullable, required — The EUVD identifier from the European Union Vulnerability Database.
        - `description` string, nullable, required — Vulnerability description as published by EUVD.
        - `published_time` string, date-time, nullable, required — Date the vulnerability was published in EUVD.
        - `cvss` number, nullable, required — CVSS base score as recorded by EUVD.
        - `cvss_version` string, nullable, required — CVSS version used for the EUVD base score.
        - `epss` number, nullable, required — EPSS score as recorded by EUVD.
        - `assigner` string, nullable, required — Organisation that assigned this EUVD entry.
        - `references` string[], nullable, required — References listed in the EUVD entry.
        - `products` string[], nullable, required — Products listed in the EUVD entry.
        - `vendors` string[], nullable, required — Vendors listed in the EUVD entry.
  - CVEsTotal
    - `total` integer, nullable — The total count of CVE entries that match a given query. This is useful for understanding the scope of vulnerabilities affecting a specific product or component without retrieving detailed information about each entry.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/shodan/apis/cvedb.md) · [All operations](https://skmtc.net/shodan/apis/cvedb/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shodan/cvedb/versions/21a0c9a80453/schema)