Codefresh Helm Cluster Configs API

helm.cluster-config

Operations 2

POST /helm/cluster-config/{selector} Store cluster config #
GET /helm/cluster-config/{selector} Get cluster config #

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-cluster-configs-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-cluster-configs-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 Cluster Configs 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 Cluster Configs
  description: helm.cluster-config
  x-id: helm.cluster-config
paths:
  /helm/cluster-config/{selector}:
    post:
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                properties:
                  helmVersion:
                    type: string
                    example: helm3 | helm2
                    description: Helm version
                  testReleasePipeline:
                    type: string
                    example: 60673a0344e5219f117538f7
                    description: Ability to customize test helm release behaviour. If pipeline id is provided , this pipeline will be used during test release action (optional)
                  rollbackPipeline:
                    type: string
                    example: 60673a0344e5219f117538f7
                    description: Ability to customize rollback helm release behaviour. If pipeline id is provided , this pipeline will be used during rollback release action
                  deleteReleasePipeline:
                    type: string
                    example: 60673a0344e5219f117538f7
                    description: Ability to customize delete helm release behaviour. If pipeline id is provided , this pipeline will be used during delete release action
                  allNamespaces:
                    type: boolean
                    example: true | false
                    description: Look for releases in all namespaces or in specific one
                  tillerNamespace:
                    type: string
                    example: kube-system
                    description: Namespace where tiller is installed
                  releaseNamespaces:
                    type: array
                    items:
                      type: string
                    description: This field should be used if allNamespaces is not defined
      tags:
      - Helm Cluster Configs
      operationId: helm-cluster-config-store
      parameters:
      - in: path
        name: selector
        description: Cluster selector
        schema:
          type: string
        required: true
      requestBody:
        content:
          application/json:
            schema:
              properties:
                helmVersion:
                  type: string
                  example: helm3 | helm2
                  description: Helm version
                testReleasePipeline:
                  type: string
                  example: 60673a0344e5219f117538f7
                  description: Ability to customize test helm release behaviour. If pipeline id is provided , this pipeline will be used during test release action (optional)
                rollbackPipeline:
                  type: string
                  example: 60673a0344e5219f117538f7
                  description: Ability to customize rollback helm release behaviour. If pipeline id is provided , this pipeline will be used during rollback release action
                deleteReleasePipeline:
                  type: string
                  example: 60673a0344e5219f117538f7
                  description: Ability to customize delete helm release behaviour. If pipeline id is provided , this pipeline will be used during delete release action
                allNamespaces:
                  type: boolean
                  example: true | false
                  description: Look for releases in all namespaces or in specific one
                tillerNamespace:
                  type: string
                  example: kube-system
                  description: Namespace where tiller is installed
                releaseNamespaces:
                  type: array
                  items:
                    type: string
                  description: This field should be used if allNamespaces is not defined
      summary: Store cluster config
      description: 'Configure helm configuration, helm configuration uses for retrieve helm data from clusters. Details here: https://codefresh.io/docs/docs/new-helm/helm-releases-management/'
      x-sdk-interface: helm.cluster-config.store
      x-endpoint:
        isEndpoint: false
        auth:
          middleware:
          - auth.isAuthenticated
          acl:
            resource: cluster
        postMiddleware:
        - global.iseMiddleware
        handler: helm.storeClusterConfig
      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/helm/cluster-config/${SELECTOR}\""
      - lang: node.js
        source: sdk.helm.cluster-config.store({ selector }, { ...REQUEST_BODY_OBJ })
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  helmVersion:
                    type: string
                    example: helm3 | helm2
                    description: Helm version
                  testReleasePipeline:
                    type: string
                    example: 60673a0344e5219f117538f7
                    description: Ability to customize test helm release behaviour. If pipeline id is provided , this pipeline will be used during test release action (optional)
                  rollbackPipeline:
                    type: string
                    example: 60673a0344e5219f117538f7
                    description: Ability to customize rollback helm release behaviour. If pipeline id is provided , this pipeline will be used during rollback release action
                  deleteReleasePipeline:
                    type: string
                    example: 60673a0344e5219f117538f7
                    description: Ability to customize delete helm release behaviour. If pipeline id is provided , this pipeline will be used during delete release action
                  allNamespaces:
                    type: boolean
                    example: true | false
                    description: Look for releases in all namespaces or in specific one
                  tillerNamespace:
                    type: string
                    example: kube-system
                    description: Namespace where tiller is installed
                  releaseNamespaces:
                    type: array
                    items:
                      type: string
                    description: This field should be used if allNamespaces is not defined
          description: ''
      tags:
      - Helm Cluster Configs
      operationId: helm-cluster-config-get
      parameters:
      - in: path
        name: selector
        description: Cluster selector
        schema:
          type: string
        required: true
      summary: Get cluster config
      description: 'Get helm configuration, helm configuration uses for retrieve helm data from clusters. Details here: https://codefresh.io/docs/docs/new-helm/helm-releases-management/'
      x-sdk-interface: helm.cluster-config.get
      x-endpoint:
        isEndpoint: false
        auth:
          middleware:
          - auth.isAuthenticated
          acl:
            resource: cluster
        postMiddleware:
        - global.iseMiddleware
        handler: helm.getClusterConfig
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X GET \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/helm/cluster-config/${SELECTOR}\""
      - lang: node.js
        source: sdk.helm.cluster-config.get({ selector })
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 (135 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codefresh/refs/heads/main/openapi/codefresh-helm-cluster-configs-api-openapi.yml