---
title: "Get a list of registries"
method: GET
path: "/scan/registry"
tags: ["Scan"]
---

# Get a list of registries

`GET /scan/registry`

## Request

- Base URL: `/v1` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/v1/scan/registry`
- Auth: none declared. Required headers: `X-Auth-Token`
- TypeScript: <https://skmtc.dev/neuvector/apis/neuvector-api/docs/scan/registry/get.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `X-Auth-Token` string, required

## Response `200`

Success

- RESTRegistrySummaryListData
  - `summarys` RESTRegistrySummary[], required
    - `name` string, required
    - `registry_type` string, required
    - `registry` string, required
    - `username` string, required
    - `password` string
    - `auth_token` string
    - `auth_with_token` boolean, required
    - `filters` string[], required
    - `rescan_after_db_update` boolean, required
    - `scan_layers` boolean, required
    - `repo_limit` integer, required
    - `tag_limit` integer, required
    - `schedule` RESTScanSchedule, required
      - `schedule` string, required
      - `interval` integer, required
    - `aws_key` RESTAWSAccountKey
      - `id` string, required
      - `access_key_id` string
      - `secret_access_key` string
      - `region` string, required
    - `jfrog_xray` RESTJfrogXray
      - `url` string, required
      - `enable` boolean, required
      - `username` string, required
      - `password` string
    - `gcr_key` RESTGCRKey
      - `json_key` string
    - `jfrog_mode` string, required
    - `gitlab_external_url` string, required
    - `gitlab_private_token` string
    - `ibm_cloud_token_url` string, required
    - `ibm_cloud_account` string, required
    - `status` string, required
    - `error_message` string, required
    - `error_detail` string, required
    - `started_at` string, required
    - `scanned` integer, required
    - `scheduled` integer, required
    - `scanning` integer, required
    - `failed` integer, required
    - `cvedb_version` string, required
    - `cvedb_create_time` string, required

---

[API](https://skmtc.dev/neuvector/apis/neuvector-api.md) - [All operations](https://skmtc.dev/neuvector/apis/neuvector-api/llms.txt) - [OpenAPI document](https://skmtc.dev/neuvector/apis/neuvector-api/revisions/b8d8d28840b3?raw)