GoHarbor health API

The health API from GoHarbor — 2 operation(s) for health.

OpenAPI Specification

goharbor-health-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Harbor artifacts health 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: health
paths:
  /health:
    get:
      tags:
      - health
      summary: Check the status of Harbor components
      operationId: getHealth
      security: []
      responses:
        '200':
          description: OK
  /statistics:
    get:
      tags:
      - health
      summary: Get statistics for the Harbor system
      operationId: getStatistics
      responses:
        '200':
          description: OK
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Harbor user credentials (HTTP Basic)