Codefresh

Codefresh Runtime Environments API

runtimeEnvs

Documentation GitHub OpenAPI

Operations 8

GET /runtime-environments List #

PUT /runtime-environments/default/{runtimeEnvironmentName} Set default #

GET /runtime-environments/{runtimeEnvironmentName} Get #

PUT /runtime-environments/{runtimeEnvironmentName} Update #

DELETE /runtime-environments/{runtimeEnvironmentName} Delete #

GET /runtime-environments/{runtimeEnvironmentName}/base-images Get images #

GET /admin/runtime-environments List #

GET /admin/runtime-environments/{plan}/{runtimeEnvironmentName} Get #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/codefresh/refs/heads/main/openapi/codefresh-runtime-environments-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-runtime-environments-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

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 Runtime Environments 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: Runtime Environments
  description: runtimeEnvs
  x-id: runtimeEnvs
paths:
  /runtime-environments:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Runtime Environments
      operationId: runtime-envs-list
      parameters:
      - in: query
        name: limit
        schema:
          type: string
        description: Limit
      - in: query
        name: offset
        schema:
          type: string
        description: Offset
      summary: List
      x-sdk-interface: runtimeEnvs.list
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X GET \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/runtime-environments?limit=${LIMIT}&offset=${OFFSET}\""
      - lang: node.js
        source: sdk.runtimeEnvs.list({ limit, offset })
  /runtime-environments/default/{runtimeEnvironmentName}:
    put:
      x-action: upsertRuntimeEnv
      x-entityId:
        pathId: body._id
        pathName: params.runtimeEnvironmentName
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Runtime Environments
      operationId: runtime-envs-set-default
      parameters:
      - in: path
        name: runtimeEnvironmentName
        schema:
          type: string
        required: true
        description: Runtime environment name
      summary: Set default
      x-sdk-interface: runtimeEnvs.setDefault
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X PUT \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/runtime-environments/default/${RUNTIME_ENVIRONMENT_NAME}\""
      - lang: node.js
        source: sdk.runtimeEnvs.setDefault({ runtimeEnvironmentName })
  /runtime-environments/{runtimeEnvironmentName}:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Runtime Environments
      operationId: runtime-envs-get
      parameters:
      - in: path
        name: runtimeEnvironmentName
        schema:
          type: string
        required: true
        description: Runtime environment name
      - in: query
        name: version
        schema:
          type: string
        description: Version
      - in: query
        name: extend
        schema:
          type: string
        description: Extend
      - in: query
        name: history
        schema:
          type: string
        description: History
      summary: Get
      x-sdk-interface: runtimeEnvs.get
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X GET \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/runtime-environments/${RUNTIME_ENVIRONMENT_NAME}?version=${VERSION}&extend=${EXTEND}&history=${HISTORY}\""
      - lang: node.js
        source: "sdk.runtimeEnvs.get({\n    runtimeEnvironmentName,\n    version,\n    extend,\n    history\n})"
    put:
      x-action: upsertRuntimeEnv
      x-entityId:
        pathId: body._id
        pathName: params.runtimeEnvironmentName
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Runtime Environments
      operationId: runtime-envs-update
      parameters:
      - in: path
        name: runtimeEnvironmentName
        schema:
          type: string
        required: true
        description: Runtime environment name
      - in: query
        name: extend
        schema:
          type: string
        description: Extend
      - in: query
        name: description
        schema:
          type: string
        description: Description
      requestBody:
        content:
          application/json:
            schema:
              type: object
      summary: Update
      x-sdk-interface: runtimeEnvs.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 \"${REQUEST_BODY_OBJ}\" \\\n    \"https://g.codefresh.io/api/runtime-environments/${RUNTIME_ENVIRONMENT_NAME}?extend=${EXTEND}&description=${DESCRIPTION}\""
      - lang: node.js
        source: sdk.runtimeEnvs.update({ runtimeEnvironmentName, extend, description }, { ...REQUEST_BODY_OBJ })
    delete:
      x-action: deleteRuntimeEnv
      x-entityId:
        pathName: params.runtimeEnvironmentName
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Runtime Environments
      operationId: runtime-envs-delete
      parameters:
      - in: path
        name: runtimeEnvironmentName
        schema:
          type: string
        required: true
        description: Runtime environment name
      - in: query
        name: force
        schema:
          type: string
        description: Force
      summary: Delete
      x-sdk-interface: runtimeEnvs.delete
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X DELETE \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/runtime-environments/${RUNTIME_ENVIRONMENT_NAME}?force=${FORCE}\""
      - lang: node.js
        source: sdk.runtimeEnvs.delete({ runtimeEnvironmentName, force })
  /runtime-environments/{runtimeEnvironmentName}/base-images:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
        '404':
          description: Runtime Not found
      tags:
      - Runtime Environments
      operationId: runtime-envs-get-base-images
      parameters:
      - in: path
        name: runtimeEnvironmentName
        schema:
          type: string
        required: true
        description: Runtime environment name
      summary: Get images
      x-sdk-interface: runtimeEnvs.getBaseImages
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X GET \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/runtime-environments/${RUNTIME_ENVIRONMENT_NAME}/base-images\""
      - lang: node.js
        source: sdk.runtimeEnvs.getBaseImages({ runtimeEnvironmentName })
  /admin/runtime-environments:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Runtime Environments
      operationId: onPrem-runtimeEnvs-list
      parameters:
      - in: query
        name: limit
        schema:
          type: string
        description: Limit
      - in: query
        name: offset
        schema:
          type: string
        description: Offset
      - in: query
        name: accountIds
        schema:
          type: string
        description: Account ids
      summary: List
      x-sdk-interface: onPrem.runtimeEnvs.list
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X GET \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/admin/runtime-environments?limit=${LIMIT}&offset=${OFFSET}&accountIds=${ACCOUNT_IDS}\""
      - lang: node.js
        source: sdk.onPrem.runtimeEnvs.list({ limit, offset, accountIds })
  /admin/runtime-environments/{plan}/{runtimeEnvironmentName}:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Runtime Environments
      operationId: onPrem-runtimeEnvs-plan-get
      parameters:
      - in: path
        name: plan
        schema:
          type: string
        required: true
        description: Plan
      - in: path
        name: runtimeEnvironmentName
        schema:
          type: string
        required: true
        description: Runtime environment name
      - in: query
        name: version
        schema:
          type: string
        description: Version
      - in: query
        name: extend
        schema:
          type: string
        description: Extend
      - in: query
        name: history
        schema:
          type: string
        description: History
      - in: query
        name: successors
        schema:
          type: string
        description: Successors
      summary: Get
      x-sdk-interface: onPrem.runtimeEnvs.plan.get
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X GET \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/admin/runtime-environments/${PLAN}/${RUNTIME_ENVIRONMENT_NAME}?version=${VERSION}&extend=${EXTEND}&history=${HISTORY}&successors=${SUCCESSORS}\""
      - lang: node.js
        source: "sdk.onPrem.runtimeEnvs.plan.get({\n    plan,\n    runtimeEnvironmentName,\n    version,\n    extend,\n    history,\n    successors\n})"
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 (136 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codefresh/refs/heads/main/openapi/codefresh-runtime-environments-api-openapi.yml