# GoHarbor Scanner API

**Canonical:** https://apis.io/apis/goharbor/goharbor-scanner-api/  
**Provider:** GoHarbor — https://apis.io/providers/goharbor/  
**Base URL:** https://{host}/api/v2.0  
**Documentation:** https://goharbor.io/docs/2.15.0/working-with-projects/using-api-explorer/

GoHarbor Scanner API is one of 38 APIs that [GoHarbor](https://apis.io/providers/goharbor/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Scanner. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The scanner API from GoHarbor — 7 operation(s) for scanner.

## Operations (11)

| Method | Path | Summary |
|---|---|---|
| GET | `/scanners` | List scanner registrations |
| POST | `/scanners` | Create a scanner registration |
| POST | `/scanners/ping` | Tests scanner registration settings |
| GET | `/scanners/{registration_id}` | Get a scanner registration details |
| PUT | `/scanners/{registration_id}` | Update a scanner registration |
| DELETE | `/scanners/{registration_id}` | Delete a scanner registration |
| PATCH | `/scanners/{registration_id}` | Set system default scanner registration |
| GET | `/scanners/{registration_id}/metadata` | Get the metadata of the specified scanner registration |
| GET | `/metadata` | Get scanner metadata |
| POST | `/scan` | Accept artifact scanning request |
| GET | `/scan/{scan_request_id}/report` | Get scan report |

## Machine-readable artifacts (10)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/goharbor/refs/heads/main/openapi/goharbor-scanner-api-openapi.yml
- **Documentation** — https://goharbor.io/docs/2.15.0/working-with-projects/using-api-explorer/
- **SourceCode** — https://github.com/goharbor/harbor
- **Documentation** — https://goharbor.io/docs/2.15.0/
- **APIReference** — https://goharbor.io/docs/2.15.0/working-with-projects/using-api-explorer/
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/goharbor/refs/heads/main/data-model/goharbor-data-model.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/goharbor/refs/heads/main/errors/goharbor-problem-types.yml
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/goharbor/refs/heads/main/asyncapi/goharbor-webhooks.yml
- **Documentation** — https://goharbor.io/docs/2.15.0/administration/vulnerability-scanning/
- **SourceCode** — https://github.com/goharbor/pluggable-scanner-spec

## Other GoHarbor APIs (12)

- [GoHarbor Health API](https://apis.io/apis/goharbor/goharbor-health-api/)
- [GoHarbor Replication API](https://apis.io/apis/goharbor/goharbor-replication-api/)
- [GoHarbor Scan API](https://apis.io/apis/goharbor/goharbor-scan-api/)
- [GoHarbor Search API](https://apis.io/apis/goharbor/goharbor-search-api/)
- [GoHarbor Artifact API](https://apis.io/apis/goharbor/goharbor-artifact-api/)
- [GoHarbor Configure API](https://apis.io/apis/goharbor/goharbor-configure-api/)
- [GoHarbor Gc API](https://apis.io/apis/goharbor/goharbor-gc-api/)
- [GoHarbor Icon API](https://apis.io/apis/goharbor/goharbor-icon-api/)
- [GoHarbor Immutable API](https://apis.io/apis/goharbor/goharbor-immutable-api/)
- [GoHarbor Label API](https://apis.io/apis/goharbor/goharbor-label-api/)
- [GoHarbor Ldap API](https://apis.io/apis/goharbor/goharbor-ldap-api/)
- [GoHarbor Member API](https://apis.io/apis/goharbor/goharbor-member-api/)

## Tags

Scanner

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/goharbor/goharbor-scanner-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/goharbor/.