---
title: "Get scanner registration candidates for configurating project level scanner"
method: GET
path: "/projects/{project_name_or_id}/scanner/candidates"
tags: ["project"]
---

# Get scanner registration candidates for configurating project level scanner

`GET /projects/{project_name_or_id}/scanner/candidates`

Retrieve the system configured scanner registrations as candidates of setting project level scanner.

## Path parameters

- `project_name_or_id` string, required

## Query parameters

- `q` string
- `sort` string
- `page` integer
- `page_size` integer

## Headers

- `X-Request-Id` string
- `X-Is-Resource-Name` boolean

## Response `200`

A list of scanner registrations.

- ScannerRegistration[]
  - `uuid` string — The unique identifier of this registration.
  - `name` string — The name of this registration.
  - `description` string — An optional description of this registration.
  - `url` string, uri — A base URL of the scanner adapter
  - `disabled` boolean — Indicate whether the registration is enabled or not
  - `is_default` boolean — Indicate if the registration is set as the system default one
  - `auth` string — Specify what authentication approach is adopted for the HTTP communications. Supported types Basic", "Bearer" and api key header "X-ScannerAdapter-API-Key"
  - `access_credential` string — An optional value of the HTTP Authorization header sent with each request to the Scanner Adapter API.
  - `skip_certVerify` boolean — Indicate if skip the certificate verification when sending HTTP requests
  - `use_internal_addr` boolean — Indicate whether use internal registry addr for the scanner to pull content or not
  - `create_time` string, date-time — The creation time of this registration
  - `update_time` string, date-time — The update time of this registration
  - `adapter` string — Optional property to describe the name of the scanner registration
  - `vendor` string — Optional property to describe the vendor of the scanner registration
  - `version` string — Optional property to describe the version of the scanner registration
  - `health` string — Indicate the healthy of the registration
  - `capabilities` object — Indicates the capabilities of the scanner, e.g. support_vulnerability or support_sbom.

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal server error

---

[API](https://skmtc.dev/cerit/apis/harbor-api.md) · [All operations](https://skmtc.dev/cerit/apis/harbor-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cerit/harbor-api/revisions/62d78801f8df/schema)