Helm

Package manager for Kubernetes that helps you define, install, and upgrade complex Kubernetes applications using charts. Helm uses a packaging format called charts, which are collections of files that describe a related set of Kubernetes resources. A chart repository is an HTTP server that houses an index.yaml file and packaged chart archives.

8 APIs 0 Features

ChartsCloud NativeContainer OrchestrationDevOpsKubernetesPackage Manager

APIs

Helm Chart Repository API

The Helm Chart Repository API defines the HTTP endpoints used by Helm clients to discover and download charts from a repository server. This includes the index.yaml endpoint for...

Helm Chart.yaml Schema

JSON Schema defining the structure and validation rules for Chart.yaml, the metadata file required in every Helm chart. Describes chart name, version, dependencies, maintainers,...

Helm Values YAML Schema

JSON Schema describing common conventional patterns for values.yaml files in Helm charts. Values.yaml provides default configuration values including container image settings, s...

Helm Repository Index Schema

JSON Schema for the index.yaml file served by Helm chart repositories. The index is the primary discovery mechanism listing all available charts and versions with download URLs ...

Helm JSON-LD Context

JSON-LD context document mapping Helm concepts to linked data vocabularies including Schema.org, Dublin Core, SPDX, FOAF, and W3C PROV. Enables semantic interoperability of Helm...

Helm Go SDK

The Helm Go SDK provides Go packages for programmatically performing Helm actions such as install, upgrade, list, and rollback without using the CLI. The SDK is published as hel...

Helm Plugins

The Helm Plugins API defines the interface for extending the Helm CLI with additional subcommands. Plugins live in a single directory with a plugin.yaml descriptor and can be im...

Helm Chart Template API

The Helm Chart Template API defines the Go template language extensions, built-in objects, and Sprig function library available for authoring Helm chart templates. Templates ren...

Collections

Helm Chart Repository API

OPEN

Pricing Plans

Helm Plans Pricing

1 plans

PLANS

Rate Limits

Helm Rate Limits

1 limits

RATE LIMITS

FinOps

Helm Finops

FINOPS

Semantic Vocabularies

Helm Context

0 classes · 11 properties

JSON-LD

Resources

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Helm Chart Repository API
  version: v3.17.0
items:
- info:
    name: Repository
    type: folder
  items:
  - info:
      name: Helm Get repository index
      type: http
    http:
      method: GET
      url: https://{repository-host}/index.yaml
    docs: Retrieves the repository index file which contains metadata about all charts available in the repository. The index.yaml
      file lists every chart version along with its description, maintainers, download URLs, and content digests. Helm clients
      use this endpoint to search and resolve chart dependencies.
  - info:
      name: Helm Get repository health
      type: http
    http:
      method: GET
      url: https://{repository-host}/health
    docs: Returns the health status of the chart repository server. Useful for liveness and readiness probes in Kubernetes
      deployments.
- info:
    name: Charts
    type: folder
  items:
  - info:
      name: Helm Download chart package
      type: http
    http:
      method: GET
      url: https://{repository-host}/charts/:chartName-:version.tgz
      params:
      - name: chartName
        value: ''
        type: path
        description: The name of the chart
      - name: version
        value: ''
        type: path
        description: The SemVer 2 version of the chart
    docs: 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.
  - info:
      name: Helm Download chart provenance file
      type: http
    http:
      method: GET
      url: https://{repository-host}/charts/:chartName-:version.tgz.prov
      params:
      - name: chartName
        value: ''
        type: path
        description: The name of the chart
      - name: version
        value: ''
        type: path
        description: The SemVer 2 version of the chart
    docs: 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.
- info:
    name: ChartMuseum
    type: folder
  items:
  - info:
      name: Helm List all charts
      type: http
    http:
      method: GET
      url: https://{repository-host}/api/charts
    docs: Returns a list of all charts available in the repository grouped by chart name. This endpoint is provided by ChartMuseum
      and other enhanced chart repository implementations supporting JSON-based management.
  - info:
      name: Helm Upload chart package
      type: http
    http:
      method: POST
      url: https://{repository-host}/api/charts
      body:
        type: multipart-form
        data:
        - name: chart
          type: text
          value: ''
        - name: prov
          type: text
          value: ''
    docs: Uploads a new chart package to the repository. This endpoint is provided by ChartMuseum and other writable chart
      repository implementations. The chart archive is sent as multipart form data or as a raw binary body.
  - info:
      name: Helm Get chart versions
      type: http
    http:
      method: GET
      url: https://{repository-host}/api/charts/:chartName
      params:
      - name: chartName
        value: ''
        type: path
        description: The name of the chart
    docs: Returns all available versions for a specific chart. This endpoint is provided by ChartMuseum and other enhanced
      chart repository implementations.
  - info:
      name: Helm Get specific chart version
      type: http
    http:
      method: GET
      url: https://{repository-host}/api/charts/:chartName/:version
      params:
      - name: chartName
        value: ''
        type: path
        description: The name of the chart
      - name: version
        value: ''
        type: path
        description: The SemVer 2 version of the chart
    docs: Returns metadata for a specific version of a named chart. This endpoint is provided by ChartMuseum and other enhanced
      chart repository implementations.
  - info:
      name: Helm Delete chart version
      type: http
    http:
      method: DELETE
      url: https://{repository-host}/api/charts/:chartName/:version
      params:
      - name: chartName
        value: ''
        type: path
        description: The name of the chart
      - name: version
        value: ''
        type: path
        description: The SemVer 2 version of the chart
    docs: Deletes a specific version of a chart from the repository. This endpoint is provided by ChartMuseum and other writable
      chart repository implementations.
  - info:
      name: Helm Upload provenance file
      type: http
    http:
      method: POST
      url: https://{repository-host}/api/prov
      body:
        type: multipart-form
        data:
        - name: prov
          type: text
          value: ''
    docs: Uploads a PGP provenance file to the repository independently of a chart package. This endpoint is provided by ChartMuseum
      for cases where chart and provenance files are uploaded separately.
bundled: true