openvas-scanner — API
Scannerv0.1 Read the vendor's spec ↗
- 19 endpoints
- 1 version archived since Nov 11, 2026
- Last checked Nov 14, 2026
The authentication modes are set within a configuration file or via the argument list, when starting the server.
Get started
$ curl "/vts"
- Base URL
-
/ - Authenticate
- No authentication declared in the spec
What it covers
Open an endpoint for a runnable command, its inputs and what it returns.
Scan 8
-
DELETE
/scans/{id}Delete a scan, that is not running.Loading…
-
GET
/scans/preferencesThis endpoint provides a list of all available scan preferences, which can be set within the scan configuration via the POST /scans endpoint.Loading…
-
GET
/scans/{id}This endpoint provides information about the scan configuration provided with POST /scans.Loading…
-
GET
/scans/{id}/resultsWhile a scan is running it will generate results.Loading…
-
GET
/scans/{id}/results/{rid}Get a single result by its ID.Loading…
-
GET
/scans/{id}/statusThis endpoint provides useful information about a scan.Loading…
-
POST
/scansThis endpoint is the entrypoint to run a scan.Loading…
-
POST
/scans/{id}This endpoint is used to perform an action on the scan.Loading…
General 4
-
HEAD
/healthGet the response header.Loading…
-
HEAD
/notusGet the response header.Loading…
-
HEAD
/scansGet the response header.Loading…
-
HEAD
/vtsGet the response header.Loading…
Health 4
-
GET
/health/aliveGet application's health informationLoading…
-
GET
/health/performanceGet performance graphs.Loading…
-
GET
/health/readyGet application's health informationLoading…
-
GET
/health/startedGet application's health informationLoading…
Notus 2
-
GET
/notusGet a list of all available OS products available for the POST /notus/{os} endpoint.Loading…
-
POST
/notus/{os}Runs Notus with the given package list for the given OS.Loading…
Feed 1
-
GET
/vtsGet a list of all available vulnerability tests (VTs) to the scanner.Loading…
No endpoint matches. Clear the filter to see all 19.