vulnerability

Retrieve vulnerabilities with optional filters

Changed on

Retrieve vulnerabilities with optional filtering and pagination.

Supports light mode for minimal data (returns only vulnerability ID and source). Returns full vulnerability details by default, or only IDs and sources in light mode.

Query Parameters

source : str Optional source to filter vulnerabilities (e.g., 'CVE', 'GHSA', 'PySec'). per_page : int, default=30 Maximum number of results (capped at 100). date_sort : str Field to sort by. Options: '', 'published', 'updated', 'reserved'. sort_order : str Sort order: 'asc' or 'desc'. since : str Retrieve vulnerabilities published/updated after the specified date. page : int Pagination page number. cwe : str Filter vulnerabilities by a specific CWE ID. product : str Optional product name to filter vulnerabilities (case-insensitive). If set, the endpoint returns vulnerabilities related to this product across all vendors. Use with assigner to further narrow results. assigner : str Optional CNA/assigner short name to filter results (case-insensitive). Only effective when used with product or vendor filters. light : str If '1', returns only (vulnerability_id, source) instead of full details. with_meta : str If 'true', includes metadata for each vulnerability. Ignored in light mode. with_linked : str If 'true', includes linked vulnerabilities for each result. Ignored in light mode. with_comments : str If 'true', includes comments for each result. Ignored in light mode. with_bundles : str If 'true', includes bundles for each result. Ignored in light mode. with_sightings : str If 'true', includes sightings for each result. Ignored in light mode.

Returns

list[dict[str, Any]] | list[tuple[str, str | None]] Full vulnerability details or minimal tuples if light mode is enabled.

get/vulnerability/

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/vulnerability/
  • Auth
    API key in header X-API-KEY

Response

Success

Changes

    • info

      added the new optional query request parameter with_bundles to all path's operations

    • info

      added the new optional query request parameter with_comments to all path's operations

    • info

      added the new optional query request parameter with_linked to all path's operations

    • info

      added the new optional query request parameter with_sightings to all path's operations

    • info

      added the new optional query request parameter with_meta to all path's operations