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-system-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 (System) 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 (System)
  description: onPrem.runtimeEnvs.system
  x-id: onPrem.runtimeEnvs.system
paths:
  /admin/runtime-environments/{runtimeEnvironmentName}:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Runtime Environments (System)
      operationId: onPrem-runtimeEnvs-system-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
      - in: query
        name: successors
        schema:
          type: string
        description: Successors
      summary: Get sys re
      x-sdk-interface: onPrem.runtimeEnvs.system.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/${RUNTIME_ENVIRONMENT_NAME}?version=${VERSION}&extend=${EXTEND}&history=${HISTORY}&successors=${SUCCESSORS}\""
      - lang: node.js
        source: "sdk.onPrem.runtimeEnvs.system.get({\n    runtimeEnvironmentName,\n    version,\n    extend,\n    history,\n    successors\n})"
    put:
      x-action: upsertRuntimeEnvByAdmin
      x-entityId:
        pathName: params.runtimeEnvironmentName
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Runtime Environments (System)
      operationId: onPrem-runtimeEnvs-system-update
      parameters:
      - in: path
        name: runtimeEnvironmentName
        description: Runtime environment name
        schema:
          type: string
        required: true
      - in: query
        name: extend
        description: Extend or not
        schema:
          type: string
      - in: query
        name: description
        description: Description
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
      summary: Update sys re
      x-sdk-interface: onPrem.runtimeEnvs.system.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/admin/runtime-environments/${RUNTIME_ENVIRONMENT_NAME}?extend=${EXTEND}&description=${DESCRIPTION}\""
      - lang: node.js
        source: sdk.onPrem.runtimeEnvs.system.update({ runtimeEnvironmentName, extend, description }, { ...REQUEST_BODY_OBJ })
    delete:
      x-action: deleteRuntimeEnvByAdmin
      x-entityId:
        pathName: params.runtimeEnvironmentName
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Runtime Environments (System)
      operationId: onPrem-runtimeEnvs-system-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 sys re
      x-sdk-interface: onPrem.runtimeEnvs.system.delete
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X DELETE \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/admin/runtime-environments/${RUNTIME_ENVIRONMENT_NAME}?force=${FORCE}\""
      - lang: node.js
        source: sdk.onPrem.runtimeEnvs.system.delete({ runtimeEnvironmentName, force })
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-runtime-environments-system-api-openapi.yml