Info

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.