GitLab Packages: Helm API

openapi: 3.2.0
info:
  title: 'GitLab REST Packages: Helm API'
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: 'Packages: Helm'
  description: 'Use this API to interact with Helm package clients.


    > [!warning]

    > This API is used by the Helm-related package clients such as Helm

    > and `helm-push`,

    > and is generally not meant for manual consumption.


    These endpoints do not adhere to the standard API authentication methods.

    See the Helm registry documentation

    for details on which headers and token types are supported. Undocumented authentication methods might be removed in the future.'
  x-displayName: 'Packages: Helm'
  externalDocs:
    url: https://docs.gitlab.com/api/packages/helm/
paths:
  /api/v4/projects/{id}/packages/helm/{channel}/index.yaml:
    get:
      operationId: getApiV4ProjectsIdPackagesHelmChannelIndexYaml
      summary: Download a chart index
      description: Downloads a specified chart index for a project.
      tags:
      - 'Packages: Helm'
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: integer
          - type: string
        in: path
      - name: channel
        required: true
        description: Helm repository channel.
        schema:
          type: string
          pattern: ^([a-zA-Z0-9](\.|-|_)?){1,255}(?<!\.|-|_)$
        in: path
        example: stable
  /api/v4/projects/{id}/packages/helm/{channel}/charts/{file_name}.tgz:
    get:
      operationId: getApiV4ProjectsIdPackagesHelmChannelChartsFileNameTgz
      summary: Download a chart
      description: Downloads a specified chart for a project.
      tags:
      - 'Packages: Helm'
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: integer
          - type: string
        in: path
      - name: channel
        required: true
        description: Helm repository channel.
        schema:
          type: string
          pattern: ^([a-zA-Z0-9](\.|-|_)?){1,255}(?<!\.|-|_)$
        in: path
        example: stable
      - name: file_name
        required: true
        description: Name of the chart file.
        schema:
          type: string
        in: path
        example: mychart
  /api/v4/projects/{id}/packages/helm/api/{channel}/charts/authorize:
    post:
      operationId: postApiV4ProjectsIdPackagesHelmApiChannelChartsAuthorize
      summary: Authorize a chart upload from workhorse
      description: This feature was introduced in GitLab 14.0
      tags:
      - 'Packages: Helm'
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: integer
          - type: string
        in: path
      - name: channel
        required: true
        description: Helm repository channel.
        schema:
          type: string
          pattern: ^([a-zA-Z0-9](\.|-|_)?){1,255}(?<!\.|-|_)$
        in: path
        example: stable
  /api/v4/projects/{id}/packages/helm/api/{channel}/charts:
    post:
      operationId: postApiV4ProjectsIdPackagesHelmApiChannelCharts
      summary: Upload a chart
      description: Uploads a specified chart for a project.
      tags:
      - 'Packages: Helm'
      responses:
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: integer
          - type: string
        in: path
      - name: channel
        required: true
        description: Helm repository channel.
        schema:
          type: string
          pattern: ^([a-zA-Z0-9](\.|-|_)?){1,255}(?<!\.|-|_)$
        in: path
        example: stable
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdPackagesHelmApiChannelChartsRequest'
components:
  schemas:
    postApiV4ProjectsIdPackagesHelmApiChannelChartsRequest:
      type: object
      properties:
        chart:
          type:
          - string
          - 'null'
          format: binary
          description: The chart file to be published (generated by Multipart middleware)
      required:
      - chart
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header