List Vulnerable Packages

Description: Retrieves a list of vulnerable packages, with options to filter the results based on various criteria such as package name, visibility, token role, and remediation status.

Path: https://external.sealsecurity.io/authenticated/api/v1/packages/vulnerable

Method: GET

Authentication: See detailed explanation here.

Request Parameters

This endpoint accepts the following optional query parameters to filter the results:

Parameter Name
Type
Description
Accepted Values

package_name_contains

string

Filter packages that have this string in their name.

Any string

is_hidden

boolean

Filter packages that are hidden (true) or visible (false).

true, false

access_token_role

string

Filter packages according to the token used to detect them.

Production, Development

fix_availability

string

Filter packages by their remediation state.

sealed, seal_available, unfixable, fix_in_preparation, generate_fix

Details for fix_availability values:

  • sealed: The vulnerable package was effectively remediated by using a safer sealed version.

  • seal_available: The vulnerable package was detected, and a safer sealed version is available for use.

  • unfixable: The vulnerable package was detected; however, a sealed version is unavailable and cannot be generated due to technical reasons.

  • fix_in_preparation: The vulnerable package was detected, and a sealed version is now under development.

  • generate_fix: The vulnerable package was detected; a sealed version is currently unavailable, but you can request one.

Response

The API returns a paginated JSON array of objects, where each object represents a vulnerable package matching the applied filters.

Response Structure:

JSON

Response Fields:

Field Name
Type
Description

package_name

string

The name of the package.

package_version

string

The version of the package.

ecosystem

string

The ecosystem (e.g., npm, PyPI, Maven) of the package.

project_name

string

The name of the project where the package was detected.

open_vulnerabilities_in_original_package

array of vulnerability objects

A list of vulnerabilities that are open in the original vulnerable package.

CVE

string

Vulnerability identifier (e.g., CVE-2023-1234).

score

float

Vulnerability risk score.

fix_availability

string

The remediation state of the vulnerable package. See accepted values in the Request Parameters section for detailed descriptions.

replaced_by_sealed_version

string

The version of the sealed package that is currently being used as a replacement (if fix_availability is sealed, null otherwise).

open_vulnerabilities_in_sealed_version

array of vulnerability objects

A list of vulnerabilities that are still open in the sealed version currently being used (a safer sealed version might be available).

sealed_vulnerabilities_in_sealed_version

array of vulnerability objects

A list of vulnerabilities that were patched (sealed) in the sealed version currently being used.

last_seen

string

The date and time (ISO 8601 format) when the vulnerable package was last detected.

access_token_role

string

The type of token (Production or Development) used to detect the vulnerable package.

is_hidden

boolean

Indicates whether the vulnerable package is hidden (true) or visible (false).

The vulnerability object is composed of two fields:

Field Name
Type
Description

CVE

string

Vulnerability identifier (e.g., CVE-2023-1234).

Note that if there is no public CVE identifier, then a GHSA identifier. If there's neither, then a Snyk ID.

score

float

Vulnerability risk score. Can be null, in which case the vulnerability is rated as Low severity.

Example Requests and Responses

1. Get all vulnerable packages:

Request (cURL):

Bash

Example Response (Truncated):

JSON

2. Filter packages by name and fix availability:

Request (cURL):

Bash

Example Response:

JSON

Last updated