Codefresh

Codefresh Helm Boards API

helm.boards

GitHub OpenAPI

Operations 8

POST /helm/boards Create #
GET /helm/boards List #
DELETE /helm/boards Delete all #
GET /helm/boards/name/{name} Get by name #
GET /helm/boards/{id} Get #
PUT /helm/boards/{id} Update #
PATCH /helm/boards/{id} Patch #
DELETE /helm/boards/{id} Delete #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/codefresh/refs/heads/main/openapi/codefresh-helm-boards-api-openapi.yml

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-boards-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.

GitHub Google LinkedIn

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

OpenAPI Specification

codefresh-helm-boards-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 Boards 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 Boards
  description: helm.boards
  x-id: helm.boards
paths:
  /helm/boards:
    post:
      x-audit:
        name:
          path: body.name
          source: req
        id:
          path: _id
          source: res
      x-action: createHelmBoard
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  __v:
                    type: number
                  _id:
                    type: string
                  accountId:
                    type: string
                  filter:
                    type: string
                  name:
                    type: string
                  type:
                    type: string
                type: object
          description: Board object
        '500':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  status:
                    example: Error
                    type: string
                type: object
          description: Error
      tags:
      - Helm Boards
      operationId: helm-boards-create
      requestBody:
        content:
          application/json:
            schema:
              properties:
                filter:
                  type: string
                name:
                  type: string
              type: object
        required: true
      summary: Create
      parameters: []
      x-sdk-interface: helm.boards.create
      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 \"{\\\"filter\\\":\\\"${FILTER_STR}\\\",\\\"name\\\":\\\"${NAME_STR}\\\"}\" \\\n    \"https://g.codefresh.io/api/helm/boards\""
      - lang: node.js
        source: "sdk.helm.boards.create({\n    filter: `${FILTER_STR}`,\n    name: `${NAME_STR}`\n})"
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  properties:
                    __v:
                      type: number
                    _id:
                      type: string
                    accountId:
                      type: string
                    filter:
                      type: string
                    name:
                      type: string
                    type:
                      type: string
                  type: object
                type: array
          description: Array of Board objects
        '500':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  status:
                    example: Error
                    type: string
                type: object
          description: Error
      tags:
      - Helm Boards
      operationId: helm-boards-list
      summary: List
      parameters: []
      x-sdk-interface: helm.boards.list
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X GET \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/helm/boards\""
      - lang: node.js
        source: sdk.helm.boards.list()
    delete:
      x-action: deleteAllBoards
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  n:
                    example: 2
                    type: integer
                  ok:
                    example: 1
                    type: integer
                type: object
          description: Result of deleting
        '500':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  status:
                    example: Error
                    type: string
                type: object
          description: Error
      tags:
      - Helm Boards
      operationId: helm-boards-delete-all
      summary: Delete all
      parameters: []
      x-sdk-interface: helm.boards.deleteAll
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X DELETE \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/helm/boards\""
      - lang: node.js
        source: sdk.helm.boards.deleteAll()
  /helm/boards/name/{name}:
    get:
      parameters:
      - description: name of a board
        in: path
        name: name
        required: true
        schema:
          type: string
      - description: include sections in response
        in: query
        name: columns
        required: false
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  __v:
                    type: number
                  _id:
                    type: string
                  accountId:
                    type: string
                  filter:
                    type: string
                  name:
                    type: string
                  type:
                    type: string
                type: object
          description: Board object
        '404':
          description: Not found
        '500':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  status:
                    example: Error
                    type: string
                type: object
          description: Error
      tags:
      - Helm Boards
      operationId: helm-boards-get-by-name
      summary: Get by name
      x-sdk-interface: helm.boards.getByName
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X GET \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/helm/boards/name/${NAME}?columns=${COLUMNS}\""
      - lang: node.js
        source: sdk.helm.boards.getByName({ name, columns })
  /helm/boards/{id}:
    get:
      parameters:
      - description: ID of an object
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  __v:
                    type: number
                  _id:
                    type: string
                  accountId:
                    type: string
                  filter:
                    type: string
                  name:
                    type: string
                  type:
                    type: string
                type: object
          description: Board object
        '404':
          description: Not found
        '500':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  status:
                    example: Error
                    type: string
                type: object
          description: Error
      tags:
      - Helm Boards
      operationId: helm-boards-get
      summary: Get
      x-sdk-interface: helm.boards.get
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X GET \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/helm/boards/${ID}\""
      - lang: node.js
        source: sdk.helm.boards.get({ id })
    put:
      x-entityId:
        pathId: params.id
        pathName: body.name
      x-action: editHelmBoard
      parameters:
      - description: ID of an object
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  __v:
                    type: number
                  _id:
                    type: string
                  accountId:
                    type: string
                  filter:
                    type: string
                  name:
                    type: string
                  type:
                    type: string
                type: object
          description: Board object
        '404':
          description: Not found
        '500':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  status:
                    example: Error
                    type: string
                type: object
          description: Error
      tags:
      - Helm Boards
      operationId: helm-boards-update
      requestBody:
        content:
          application/json:
            schema:
              properties:
                filter:
                  type: string
                name:
                  type: string
              type: object
        required: true
      summary: Update
      x-sdk-interface: helm.boards.update
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X PUT \\\n    -H \"Authorization: ${API_KEY}\" \\\n    -H 'Content-Type: application/json; charset=utf-8' \\\n    -d \"{\\\"filter\\\":\\\"${FILTER_STR}\\\",\\\"name\\\":\\\"${NAME_STR}\\\"}\" \\\n    \"https://g.codefresh.io/api/helm/boards/${ID}\""
      - lang: node.js
        source: "sdk.helm.boards.update({ id }, {\n    filter: `${FILTER_STR}`,\n    name: `${NAME_STR}`\n})"
    patch:
      parameters:
      - description: ID of an object
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  __v:
                    type: number
                  _id:
                    type: string
                  accountId:
                    type: string
                  filter:
                    type: string
                  name:
                    type: string
                  type:
                    type: string
                type: object
          description: Board object
        '404':
          description: Not found
        '500':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  status:
                    example: Error
                    type: string
                type: object
          description: Error
      tags:
      - Helm Boards
      operationId: helm-boards-patch
      requestBody:
        content:
          application/json:
            schema:
              properties:
                filter:
                  type: string
                name:
                  type: string
              type: object
        required: true
      summary: Patch
      x-sdk-interface: helm.boards.patch
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X PATCH \\\n    -H \"Authorization: ${API_KEY}\" \\\n    -H 'Content-Type: application/json; charset=utf-8' \\\n    -d \"{\\\"filter\\\":\\\"${FILTER_STR}\\\",\\\"name\\\":\\\"${NAME_STR}\\\"}\" \\\n    \"https://g.codefresh.io/api/helm/boards/${ID}\""
      - lang: node.js
        source: "sdk.helm.boards.patch({ id }, {\n    filter: `${FILTER_STR}`,\n    name: `${NAME_STR}`\n})"
    delete:
      x-entityId: params.id
      x-action: deleteHelmBoard
      parameters:
      - description: ID of an object
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  __v:
                    type: number
                  _id:
                    type: string
                  accountId:
                    type: string
                  filter:
                    type: string
                  name:
                    type: string
                  type:
                    type: string
                type: object
          description: Board object
        '404':
          description: Not found
        '500':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  status:
                    example: Error
                    type: string
                type: object
          description: Error
      tags:
      - Helm Boards
      operationId: helm-boards-delete
      summary: Delete
      x-sdk-interface: helm.boards.delete
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X DELETE \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/helm/boards/${ID}\""
      - lang: node.js
        source: sdk.helm.boards.delete({ id })
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 (140 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codefresh/refs/heads/main/openapi/codefresh-helm-boards-api-openapi.yml