Sign in
scanner

List scanner registrations

Returns a list of currently configured scanner registrations.

get/scanners

Query parameters

qstring

Query string to query resources. Supported query patterns are "exact match(k=v)", "fuzzy match(k=v)", "range(k=[minmax])", "list with union releationship(k={v1 v2 v3})" and "list with intersetion relationship(k=(v1 v2 v3))". The value of range and list can be string(enclosed by " or '), integer or time(in format "2020-04-09 02:36:00"). All of these query patterns should be put in the query string "q=xxx" and splitted by ",". e.g. q=k1=v1,k2=v2,k3=[minmax]

sortstring

Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending order and field2 in descending order with "sort=field1,-field2"

pageinteger

The page number

page_sizeinteger

The size of per page

Headers

X-Request-Idstring

An unique ID for the request

Response

A list of scanner registrations.

uuidstring

The unique identifier of this registration.

namestring

The name of this registration.

descriptionstring

An optional description of this registration.

urlstring uri

A base URL of the scanner adapter

disabledboolean

Indicate whether the registration is enabled or not

is_defaultboolean

Indicate if the registration is set as the system default one

authstring

Specify what authentication approach is adopted for the HTTP communications. Supported types Basic", "Bearer" and api key header "X-ScannerAdapter-API-Key"

access_credentialstring

An optional value of the HTTP Authorization header sent with each request to the Scanner Adapter API.

skip_certVerifyboolean

Indicate if skip the certificate verification when sending HTTP requests

use_internal_addrboolean

Indicate whether use internal registry addr for the scanner to pull content or not

create_timestring date-time

The creation time of this registration

update_timestring date-time

The update time of this registration

adapterstring

Optional property to describe the name of the scanner registration

vendorstring

Optional property to describe the vendor of the scanner registration

versionstring

Optional property to describe the version of the scanner registration

healthstring

Indicate the healthy of the registration

capabilitiesobject

Indicates the capabilities of the scanner, e.g. support_vulnerability or support_sbom.

Example response

[
  {
    "name": "Trivy",
    "description": "A free-to-use tool that scans container images for package vulnerabilities.\n",
    "url": "http://harbor-scanner-trivy:8080",
    "auth": "Bearer",
    "access_credential": "Bearer: JWTTOKENGOESHERE",
    "adapter": "Trivy",
    "vendor": "CentOS",
    "version": "1.0.1",
    "health": "healthy",
    "capabilities": {
      "support_vulnerability": true,
      "support_sbom": true
    }
  }
]

Changes