v1

latestOpenAPI 3.1.02026-08-06330343826.1 KB
Vulnerability Check

Checks

Returns vulnerability checks. Optional search and filtering parameters may be supplied to refine the results. Searching allows full text search of the vulnerability details a check is related to.

get/api/3/vulnerability_checks

Query parameters

pageinteger

The index of the page (zero-based) to retrieve.

potentialboolean

Whether to only return checks that result in potentially vulnerable results. Defaults to return all checks.

requiresCredentialsboolean

Whether to only return checks that require credentials in order to successfully execute. Defaults to return all checks.

safeboolean

Whether to return vulnerability checks that are considered "safe" to run. Defaults to return safe and unsafe checks.

searchstring

Vulnerability search term to find vulnerability checks for. e.g. "ssh".

sizeinteger

The number of records per page to retrieve.

sortstring[]

The criteria to sort the records by, in the format: property[,ASC|DESC]. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.

typestring

The type of vulnerability checks to return. See <a href="#operation/vulnerabilityCheckTypesUsingGET">Check Types</a> for all available types.

The type of vulnerability checks to return. See <a href="#operation/vulnerabilityCheckTypesUsingGET">Check Types</a> for all available types.

uniqueboolean

Whether to only return checks that guarantee to be executed once-and-only once on a host resulting in a unique result. False returns checks that can result in multiple occurrences of the same vulnerability on a host.

Response

OK