Sign in
project

Get project level scanner

Get the scanner registration of the specified project. If no scanner registration is configured for the specified project, the system default scanner registration will be returned.

get/projects/{project_name_or_id}/scanner

Path parameters

project_name_or_idstring required

The name or id of the project

Headers

X-Request-Idstring

An unique ID for the request

X-Is-Resource-Nameboolean

The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.

Response

The details of the scanner registration.

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

No recorded changes to this endpoint across all 1 revision of this API.