Interface OsvQueryParams

Parameters for a single vulnerability query (POST /v1/query).

Provide either package + version to query by package version, or commit to query by a specific git commit hash.

Example

// Query by package + version
const result = await osv.query({
  package: { name: 'lodash', ecosystem: 'npm' },
  version: '4.17.20',
});

// Query by git commit
const result = await osv.query({ commit: 'abc123...' });
interface OsvQueryParams {
    commit?: string;
    package?: OsvPackageIdentifier;
    page_size?: number;
    page_token?: string;
    version?: string;
}

Properties

commit? package? page_size? page_token? version?

Properties

Optionalcommit

commit?: string

Git commit hash to query vulnerabilities for

Optionalpackage

package?: OsvPackageIdentifier

Package to query — use alongside version

Optionalpage_size

page_size?: number

Maximum number of results to return

Optionalpage_token

page_token?: string

Token for retrieving the next page of results

Optionalversion

version?: string

Package version string to query vulnerabilities for

Settings

Member Visibility

On This Page

Properties