PAGES

← openvas-scanner

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

first call
$ curl "/vts"
Base URL
/
Authenticate
No authentication declared in the spec

What it covers

Endpoints

19 of 19

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/preferences This 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}/results While 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}/status This endpoint provides useful information about a scan.

    Loading…

  • POST /scans This 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 /health Get the response header.

    Loading…

  • HEAD /notus Get the response header.

    Loading…

  • HEAD /scans Get the response header.

    Loading…

  • HEAD /vts Get the response header.

    Loading…

Health 4

  • GET /health/alive Get application's health information

    Loading…

  • GET /health/performance Get performance graphs.

    Loading…

  • GET /health/ready Get application's health information

    Loading…

  • GET /health/started Get application's health information

    Loading…

Notus 2

  • GET /notus Get 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 /vts Get a list of all available vulnerability tests (VTs) to the scanner.

    Loading…

Saved in this browser. Sign in to sync your tools.