vulns

Get vulns.

Get a list of vulnerabilities with optional filtering, sorting, and pagination.

Filtering:

  • min_cvss_v3_score: Minimum CVSS v3 score (float).
  • max_cvss_v3_score: Maximum CVSS v3 score (float).
  • vuln_ids: List of vuln IDs to filter by.
  • title_words: List of words to search in the title (case-insensitive).
  • detail_words: List of words to search in the detail (case-insensitive).
  • creator_ids: List of creator IDs to filter by.
  • created_after: Filter vulnerabilities created after this datetime.
  • created_before: Filter vulnerabilities created before this datetime.
  • updated_after: Filter vulnerabilities updated after this datetime.
  • updated_before: Filter vulnerabilities updated before this datetime.
  • pteam_id: Filter vulnerabilities associated with this PTeam ID.
  • cve_ids: List of CVE IDs to filter by.
  • package_name: List of package names to filter by.
  • ecosystem: List of ecosystems to filter by.

Sorting:

  • sort_keys: Sort key for the results. Default is ["-cvss_v3_score", "-updated_at"].
    • Supported values:
      • cvss_v3_score
      • updated_at
      • created_at
      • cve_id
  • If a minus sign is added, the order is descending. if not, the order is ascending.
    • Example: -cvss_v3_score, -updated_at, -created_at etc.
  • If only one sort key is provided, a second default sort key is automatically appended. This ensures deterministic ordering. If the first key is "updated_at" or "-updated_at", "-cvss_v3_score" is appended; otherwise, "-updated_at" is appended.

Pagination:

  • offset: Number of items to skip before starting to collect the result set.
  • limit: Maximum number of items to return.

Defaults are None for all filtering parameters, which means skip filtering. Different parameters are combined with AND conditions. Words search is case-insensitive.

Examples:

  • ...?title_words=a&title_words=%20&title_words=B -> Title includes [a, A, b, B, or space].
  • ...?title_words=a&title_words=&title_words=B -> Title includes [a, A, b, B] or is empty.
  • ...?cve_ids=CVE-2023-1234 -> Filter by the specific CVE ID.
  • ...?package_name=example -> Filter by the package name "example".
get/vulns

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

offsetinteger
limitinteger
min_cvss_v3_scorenumber nullable
max_cvss_v3_scorenumber nullable
vuln_idsstring[] nullable
title_wordsstring[] nullable
detail_wordsstring[] nullable
creator_idsstring[] nullable
created_afterstring date-time nullable
created_beforestring date-time nullable
updated_afterstring date-time nullable
updated_beforestring date-time nullable
pteam_idstring uuid nullable
cve_idsstring[] nullable
package_namestring[] nullable
ecosystemstring[] nullable
unknown

Response

Successful Response

num_vulnsinteger required

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status