Codefresh Helm Releases API

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 Releases 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 Releases
  description: helm.releases
  x-id: helm.releases
paths:
  /kubernetes/releases/{releaseName}/delete:
    post:
      x-entityId:
        pathName: params.releaseName
      x-action: helmReleaseDeleted
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Helm Releases
      operationId: helm-releases-delete
      parameters:
      - in: path
        name: releaseName
        schema:
          type: string
        required: true
        description: Release name
      - 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
      summary: Delete
      x-sdk-interface: helm.releases.delete
      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.deleteRelease
      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/releases/${RELEASE_NAME}/delete?selector=${SELECTOR}&tillerNamespace=${TILLER_NAMESPACE}\""
      - lang: node.js
        source: sdk.helm.releases.delete({ releaseName, selector, tillerNamespace }, { ...REQUEST_BODY_OBJ })
  /kubernetes/releases/{releaseName}/test:
    post:
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Helm Releases
      operationId: helm-releases-test
      parameters:
      - in: path
        name: releaseName
        schema:
          type: string
        required: true
        description: Release name
      - in: query
        name: selector
        schema:
          type: string
        description: Selector
      requestBody:
        content:
          application/json:
            schema:
              type: object
      summary: Test
      x-sdk-interface: helm.releases.test
      x-endpoint:
        isEndpoint: false
        auth:
          middleware:
          - auth.isAuthenticated
          acl:
            resource: cluster
        preMiddleware:
        - kubernetes.resolveClustersFromQuery
        - kubernetes.extendRequestWithKubeManager
        - kubernetes.extendRequestWithTillerVersion
        postMiddleware:
        - global.iseMiddleware
        handler: kubernetes.testRelease
      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/releases/${RELEASE_NAME}/test?selector=${SELECTOR}\""
      - lang: node.js
        source: sdk.helm.releases.test({ releaseName, selector }, { ...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 (131 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codefresh/refs/heads/main/openapi/codefresh-helm-releases-api-openapi.yml