Helm Charts API

openapi: 3.1.0
info:
  title: Helm Chart Repository ChartMuseum Charts API
  description: The Helm Chart Repository API defines the HTTP endpoints used by Helm clients to discover and download charts from a repository server. A chart repository is an HTTP server that houses an index.yaml file listing all available charts and optionally packaged chart archives (.tgz files). ChartMuseum and compatible implementations extend this with a JSON-based management API for listing, uploading, and deleting charts programmatically.
  version: v3.17.0
  contact:
    name: Helm Project
    url: https://helm.sh
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://{repository-host}
  description: Helm Chart Repository Server
  variables:
    repository-host:
      default: charts.example.com
      description: The hostname of the chart repository
tags:
- name: Charts
  description: Chart package download endpoints for retrieving packaged chart archives and provenance files for signature verification.
paths:
  /charts/{chartName}-{version}.tgz:
    get:
      operationId: downloadChartPackage
      summary: Helm Download chart package
      description: Downloads a packaged Helm chart archive (.tgz file) for a specific chart name and version. The archive contains the Chart.yaml, values.yaml, templates, and other chart files. Helm clients use this endpoint after resolving chart references from the index.
      tags:
      - Charts
      parameters:
      - $ref: '#/components/parameters/ChartName'
      - $ref: '#/components/parameters/Version'
      responses:
        '200':
          description: Chart package returned successfully
          content:
            application/gzip:
              schema:
                type: string
                format: binary
            application/x-tar:
              schema:
                type: string
                format: binary
        '404':
          description: Chart package not found
  /charts/{chartName}-{version}.tgz.prov:
    get:
      operationId: downloadChartProvenance
      summary: Helm Download chart provenance file
      description: Downloads the provenance file for a specific chart version. The provenance file contains a PGP signature used to verify the integrity and origin of the chart package. This endpoint is optional and only available for cryptographically signed charts.
      tags:
      - Charts
      parameters:
      - $ref: '#/components/parameters/ChartName'
      - $ref: '#/components/parameters/Version'
      responses:
        '200':
          description: Provenance file returned successfully
          content:
            application/pgp-signature:
              schema:
                type: string
        '404':
          description: Provenance file not found
components:
  parameters:
    ChartName:
      name: chartName
      in: path
      required: true
      description: The name of the chart
      schema:
        type: string
        example: nginx
    Version:
      name: version
      in: path
      required: true
      description: The SemVer 2 version of the chart
      schema:
        type: string
        example: 1.2.3
externalDocs:
  description: Helm Chart Repository Guide
  url: https://helm.sh/docs/topics/chart_repository/