Codefresh Helm Charts API

helm.charts

Operations 4

POST /kubernetes/chart/install/helm3 Install #
POST /kubernetes/chart/install Install #
POST /kubernetes/chart/promote/helm3 Promote #
POST /kubernetes/chart/promote Promote #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/codefresh:codefresh-helm-charts-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

codefresh-helm-charts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  contact:
    name: Codefresh
    url: https://www.codefresh.io
  description: Codefresh API openAPI 3.0 specification
  termsOfService: https://codefresh.io/docs/docs/terms-and-privacy-policy/terms-of-service/
  title: Codefresh Helm Charts API
  version: 0.0.2
  x-logo:
    url: https://g.codefresh.io/modules/cf.resources/codefresh-api-docs-images/codefresh-logo-api.svg
    backgroundColor: '#FFFFFF'
    altText: Codefresh
servers:
- url: https://g.codefresh.io/api
security:
- API-key: []
tags:
- name: Helm Charts
  description: helm.charts
  x-id: helm.charts
paths:
  /kubernetes/chart/install/helm3:
    post:
      x-entityId:
        pathName: body.releaseName
      x-action: installHelm3Release
      responses:
        '200':
          description: Id of running pipeline for install helm release
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
      tags:
      - Helm Charts
      operationId: helm-charts-install-helm3
      parameters:
      - in: query
        name: selector
        schema:
          type: string
        required: true
        description: Selector
      - in: query
        name: tillerNamespace
        schema:
          type: string
        required: false
        description: Tiller namespace
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                namespace:
                  type: string
                releaseName:
                  type: string
                set:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                      value:
                        type: string
                values:
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                repository:
                  type: string
                version:
                  type: string
      summary: Install
      x-sdk-interface: helm.charts.install.new
      x-endpoint:
        isEndpoint: false
        auth:
          middleware:
          - auth.isAuthenticated
          - kubernetes.resolveClustersFromQuery
          acl:
            resource: cluster
            abac: true
            abacSource: kubernetes
            action: update
        preMiddleware:
        - kubernetes.extendRequestWithKubeManager
        - kubernetes.extendRequestWithTillerVersion
        - kubernetes.extendRequestWithClusterConfig
        postMiddleware:
        - global.iseMiddleware
        handler: kubernetes.installChartHelm3
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X POST \\\n    -H \"Authorization: ${API_KEY}\" \\\n    -H 'Content-Type: application/json; charset=utf-8' \\\n    -d \"{\\\"name\\\":\\\"${NAME_STR}\\\",\\\"namespace\\\":\\\"${NAMESPACE_STR}\\\",\\\"releaseName\\\":\\\"${RELEASE_NAME_STR}\\\",\\\"set\\\":[{\\\"key\\\":\\\"${KEY_STR}\\\",\\\"value\\\":\\\"${VALUE_STR}\\\"}],\\\"values\\\":[{\\\"name\\\":\\\"${NAME_STR}\\\"}],\\\"repository\\\":\\\"${REPOSITORY_STR}\\\",\\\"version\\\":\\\"${VERSION_STR}\\\"}\" \\\n    \"https://g.codefresh.io/api/kubernetes/chart/install/helm3?selector=${SELECTOR}&tillerNamespace=${TILLER_NAMESPACE}\""
      - lang: node.js
        source: "sdk.helm.charts.install.new({ selector, tillerNamespace }, {\n    name: `${NAME_STR}`,\n    namespace: `${NAMESPACE_STR}`,\n    releaseName: `${RELEASE_NAME_STR}`,\n    set: [\n        {\n            key: `${KEY_STR}`,\n            value: `${VALUE_STR}`\n        }\n    ],\n    values: [\n        {\n            name: `${NAME_STR}`\n        }\n    ],\n    repository: `${REPOSITORY_STR}`,\n    version: `${VERSION_STR}`\n})"
  /kubernetes/chart/install:
    post:
      x-entityId:
        pathName: body.releaseName
      x-action: installHelmRelease
      responses:
        '200':
          description: Id of running pipeline for install helm release
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
      tags:
      - Helm Charts
      operationId: helm-charts-install
      parameters:
      - in: query
        name: selector
        schema:
          type: string
        required: true
        description: Selector
      - in: query
        name: tillerNamespace
        schema:
          type: string
        required: true
        description: Tiller namespace
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                namespace:
                  type: string
                releaseName:
                  type: string
                set:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                      value:
                        type: string
                values:
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                repository:
                  type: string
                version:
                  type: string
      summary: Install
      x-sdk-interface: helm.charts.install
      x-endpoint:
        isEndpoint: false
        auth:
          middleware:
          - auth.isAuthenticated
          - kubernetes.resolveClustersFromQuery
          acl:
            resource: cluster
            abac: true
            abacSource: kubernetes
            action: update
        preMiddleware:
        - kubernetes.extendRequestWithKubeManager
        - kubernetes.extendRequestWithTillerVersion
        postMiddleware:
        - global.iseMiddleware
        handler: kubernetes.installChart
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X POST \\\n    -H \"Authorization: ${API_KEY}\" \\\n    -H 'Content-Type: application/json; charset=utf-8' \\\n    -d \"{\\\"name\\\":\\\"${NAME_STR}\\\",\\\"namespace\\\":\\\"${NAMESPACE_STR}\\\",\\\"releaseName\\\":\\\"${RELEASE_NAME_STR}\\\",\\\"set\\\":[{\\\"key\\\":\\\"${KEY_STR}\\\",\\\"value\\\":\\\"${VALUE_STR}\\\"}],\\\"values\\\":[{\\\"name\\\":\\\"${NAME_STR}\\\"}],\\\"repository\\\":\\\"${REPOSITORY_STR}\\\",\\\"version\\\":\\\"${VERSION_STR}\\\"}\" \\\n    \"https://g.codefresh.io/api/kubernetes/chart/install?selector=${SELECTOR}&tillerNamespace=${TILLER_NAMESPACE}\""
      - lang: node.js
        source: "sdk.helm.charts.install({ selector, tillerNamespace }, {\n    name: `${NAME_STR}`,\n    namespace: `${NAMESPACE_STR}`,\n    releaseName: `${RELEASE_NAME_STR}`,\n    set: [\n        {\n            key: `${KEY_STR}`,\n            value: `${VALUE_STR}`\n        }\n    ],\n    values: [\n        {\n            name: `${NAME_STR}`\n        }\n    ],\n    repository: `${REPOSITORY_STR}`,\n    version: `${VERSION_STR}`\n})"
  /kubernetes/chart/promote/helm3:
    post:
      x-entityId:
        pathName: body.releaseName
      x-action: promoteHelm3Release
      responses:
        '200':
          description: Id of running pipeline for promote helm release
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
      tags:
      - Helm Charts
      operationId: helm-charts-promote-helm3
      parameters:
      - in: query
        name: selector
        schema:
          type: string
        description: Selector
      - in: query
        name: tillerNamespace
        schema:
          type: string
        required: false
        description: Tiller namespace
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                targetTillerNamespace:
                  type: string
                targetNamespace:
                  type: string
                releaseName:
                  type: string
                targetReleaseName:
                  type: string
                set:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                      value:
                        type: string
                values:
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                targetSelector:
                  type: string
                revision:
                  type: string
                pipelineId:
                  type: string
      summary: Promote
      x-sdk-interface: helm.charts.promote.new
      x-endpoint:
        isEndpoint: false
        auth:
          middleware:
          - auth.isAuthenticated
          - kubernetes.resolveClustersFromBoards
          - kubernetes.resolveClustersFromQuery
          acl:
            resource: cluster
            abac: true
            abacSource: kubernetes
            action: update
            identifiersLocation: body.targetSelector
        preMiddleware:
        - kubernetes.extendRequestWithKubeManager
        - kubernetes.extendRequestWithTillerVersion
        - kubernetes.extendRequestWithClusterConfig
        postMiddleware:
        - global.iseMiddleware
        utility:
          bodyParser:
            limit: 5mb
        handler: kubernetes.promoteChartHelm3
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X POST \\\n    -H \"Authorization: ${API_KEY}\" \\\n    -H 'Content-Type: application/json; charset=utf-8' \\\n    -d \"{\\\"targetTillerNamespace\\\":\\\"${TARGET_TILLER_NAMESPACE_STR}\\\",\\\"targetNamespace\\\":\\\"${TARGET_NAMESPACE_STR}\\\",\\\"releaseName\\\":\\\"${RELEASE_NAME_STR}\\\",\\\"targetReleaseName\\\":\\\"${TARGET_RELEASE_NAME_STR}\\\",\\\"set\\\":[{\\\"key\\\":\\\"${KEY_STR}\\\",\\\"value\\\":\\\"${VALUE_STR}\\\"}],\\\"values\\\":[{\\\"name\\\":\\\"${NAME_STR}\\\"}],\\\"targetSelector\\\":\\\"${TARGET_SELECTOR_STR}\\\",\\\"revision\\\":\\\"${REVISION_STR}\\\",\\\"pipelineId\\\":\\\"${PIPELINE_ID_STR}\\\"}\" \\\n    \"https://g.codefresh.io/api/kubernetes/chart/promote/helm3?selector=${SELECTOR}&tillerNamespace=${TILLER_NAMESPACE}\""
      - lang: node.js
        source: "sdk.helm.charts.promote.new({ selector, tillerNamespace }, {\n    targetTillerNamespace: `${TARGET_TILLER_NAMESPACE_STR}`,\n    targetNamespace: `${TARGET_NAMESPACE_STR}`,\n    releaseName: `${RELEASE_NAME_STR}`,\n    targetReleaseName: `${TARGET_RELEASE_NAME_STR}`,\n    set: [\n        {\n            key: `${KEY_STR}`,\n            value: `${VALUE_STR}`\n        }\n    ],\n    values: [\n        {\n            name: `${NAME_STR}`\n        }\n    ],\n    targetSelector: `${TARGET_SELECTOR_STR}`,\n    revision: `${REVISION_STR}`,\n    pipelineId: `${PIPELINE_ID_STR}`\n})"
  /kubernetes/chart/promote:
    post:
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Helm Charts
      operationId: helm-charts-promote
      parameters:
      - in: query
        name: selector
        schema:
          type: string
        description: Selector
      - in: query
        name: tillerNamespace
        schema:
          type: string
        required: true
        description: Tiller namespace
      requestBody:
        content:
          application/json:
            schema:
              type: object
      summary: Promote
      x-sdk-interface: helm.charts.promote
      x-endpoint:
        isEndpoint: false
        auth:
          middleware:
          - auth.isAuthenticated
          - kubernetes.resolveClustersFromBoards
          - kubernetes.resolveClustersFromQuery
          acl:
            resource: cluster
            abac: true
            abacSource: kubernetes
            action: update
        preMiddleware:
        - kubernetes.extendRequestWithKubeManager
        - kubernetes.extendRequestWithTillerVersion
        postMiddleware:
        - global.iseMiddleware
        handler: kubernetes.promoteChart
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X POST \\\n    -H \"Authorization: ${API_KEY}\" \\\n    -H 'Content-Type: application/json; charset=utf-8' \\\n    -d \"${REQUEST_BODY_OBJ}\" \\\n    \"https://g.codefresh.io/api/kubernetes/chart/promote?selector=${SELECTOR}&tillerNamespace=${TILLER_NAMESPACE}\""
      - lang: node.js
        source: sdk.helm.charts.promote({ selector, tillerNamespace }, { ...REQUEST_BODY_OBJ })
components:
  securitySchemes:
    API-key:
      in: header
      name: Authorization
      description: 'An api key got from: User Settings -> API keys -> Generate'
      type: apiKey
x-service-name: api-public
x-base-path: /api
x-internal-services:
- pipeline-manager
- api
x-endpoint-conditions:
- weight: 0
  condition: global.has-general-service-role
  handlerRegex: (.*)
- weight: 1
  condition: global.has-kubernetes-endpoints-service-role
  handlerRegex: kubernetes\.\w+
- weight: 2
  condition: global.has-auth-service-role
  handlerRegex: api-key\.\w+
x-tagGroups:
- name: Pipelines / Builds
  tags:
  - Annotations
  - Builds
  - Execution Contexts
  - Images
  - Pipelines
  - Progress
  - Projects
  - Step-types
  - Triggers
  - Triggers Events
  - Triggers Types
- name: Kubernetes / Helm
  tags:
  - Environments V2
  - Helm Boards
  - Helm Charts
  - Helm Releases
  - Helm Sections
  - Kubernetes
- name: Swarm
  tags:
  - Compositions
  - Environments
- name: Integrations / Contexts
  tags:
  - Clusters
  - Contexts
  - Helm Cluster Configs
  - Helm Repos
  - Registries
  - Repos
- name: Account Management
  tags:
  - Abac
  - Accounts
  - Agents
  - Audit
  - Runtime Environments
  - Teams
  - Tokens
  - Views
- name: User Properties
  tags:
  - favorites
- name: On-Premise
  tags:
  - Features
  - Runtime Environments (Account)
  - Runtime Environments (Plan)
  - Runtime Environments (System)
  - Runtime Environments.
- name: Platform Analytics
  tags:


# --- truncated at 32 KB (139 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codefresh/refs/heads/main/openapi/codefresh-helm-charts-api-openapi.yml