# Harbor Scanner Adapter API

**Canonical:** https://apis.io/apis/goharbor/goharbor-scanner-adapter-api/  
**Provider:** GoHarbor — https://apis.io/providers/goharbor/  
**Base URL:** https://{scanner-adapter}/api/v1  
**Documentation:** https://github.com/goharbor/pluggable-scanner-spec

Harbor Scanner Adapter API is one of 16 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 Scanning and Artifacts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

The contract a vulnerability scanner vendor implements so it can be registered as a pluggable scanner in Harbor. OpenAPI 3.0, three operations — GET /metadata to advertise capabilities, POST /scan to accept an asynchronous scan request, and GET /scan/{scan_request_id}/report to return the report Harbor polls for. Published by the Harbor project in goharbor/pluggable-scanner-spec.

## Operations (3)

| Method | Path | Summary |
|---|---|---|
| GET | `/metadata` | Get scanner metadata |
| POST | `/scan` | Accept artifact scanning request |
| GET | `/scan/{scan_request_id}/report` | Get scan report |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/goharbor/refs/heads/main/openapi/goharbor-scanner-adapter-api-openapi.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 artifacts API](https://apis.io/apis/goharbor/goharbor-artifacts-api/)
- [GoHarbor audit API](https://apis.io/apis/goharbor/goharbor-audit-api/)
- [GoHarbor health API](https://apis.io/apis/goharbor/goharbor-health-api/)
- [GoHarbor projects API](https://apis.io/apis/goharbor/goharbor-projects-api/)
- [GoHarbor quotas API](https://apis.io/apis/goharbor/goharbor-quotas-api/)
- [GoHarbor registries API](https://apis.io/apis/goharbor/goharbor-registries-api/)
- [GoHarbor replication API](https://apis.io/apis/goharbor/goharbor-replication-api/)
- [GoHarbor repositories API](https://apis.io/apis/goharbor/goharbor-repositories-api/)
- [GoHarbor robots API](https://apis.io/apis/goharbor/goharbor-robots-api/)
- [GoHarbor scan API](https://apis.io/apis/goharbor/goharbor-scan-api/)
- [GoHarbor search API](https://apis.io/apis/goharbor/goharbor-search-api/)
- [GoHarbor tags API](https://apis.io/apis/goharbor/goharbor-tags-api/)

## Tags

Scanning, Artifacts

---

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