GoHarbor scan API

The scan API from GoHarbor — 1 operation(s) for scan.

OpenAPI Specification

goharbor-scan-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Harbor artifacts scan API
  version: '2.0'
  description: 'Subset of the Harbor v2.0 REST API for the cloud-native container

    registry. Authenticates with HTTP Basic auth. Full upstream spec

    available at

    https://raw.githubusercontent.com/goharbor/harbor/main/api/v2.0/swagger.yaml

    '
  contact:
    name: Harbor
    url: https://goharbor.io/
servers:
- url: https://{host}/api/v2.0
  description: Harbor instance
  variables:
    host:
      default: harbor.example.com
security:
- basicAuth: []
tags:
- name: scan
paths:
  /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/scan:
    post:
      tags:
      - scan
      summary: Trigger an artifact vulnerability scan
      operationId: scanArtifact
      parameters:
      - name: project_name
        in: path
        required: true
        schema:
          type: string
      - name: repository_name
        in: path
        required: true
        schema:
          type: string
      - name: reference
        in: path
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Accepted
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Harbor user credentials (HTTP Basic)