Codefresh Runner Installation API
The runner-installation API from Codefresh — 2 operation(s) for runner-installation.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/codefresh:codefresh-runner-installation-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
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 Runner Installation 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: runner-installation
paths:
/runner-installation:
post:
responses:
'201':
content:
application/json:
schema:
type: object
description: json
tags:
- runner-installation
operationId: runner-installation-create
summary: Create new runner installation progress
x-sdk-interface: runner-installation.createNewInstallationProgress
requestBody:
content:
application/json:
schema:
type: object
x-endpoint:
isEndpoint: false
auth:
middleware:
- auth.isAuthenticated
- auth.isAccountAdminAgents
postMiddleware:
- global.iseMiddleware
handler: runner-installation.createNewInstallationProgress
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/runner-installation\""
- lang: node.js
source: sdk.runner-installation.createNewInstallationProgress({ ...REQUEST_BODY_OBJ })
parameters: []
/runner-installation/{id}:
get:
parameters:
- description: ID of an object
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
description: json
tags:
- runner-installation
operationId: runner-installation-get
summary: Get new session of runner installation progress
x-sdk-interface: runner-installation.getInstallationProgress
x-endpoint:
isEndpoint: false
auth:
middleware:
- auth.isAuthenticated
- auth.isAccountAdminAgents
postMiddleware:
- global.iseMiddleware
handler: runner-installation.getInstallationProgress
x-code-samples:
- lang: curl
source: "curl \\\n -X GET \\\n -H \"Authorization: ${API_KEY}\" \\\n \"https://g.codefresh.io/api/runner-installation/${ID}\""
- lang: node.js
source: sdk.runner-installation.getInstallationProgress({ id })
patch:
parameters:
- description: ID of an object
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
description: json
tags:
- runner-installation
operationId: runner-installation-update
summary: Update runner-installation progress
x-sdk-interface: runner-installation.reportInstallationProgressEvent
requestBody:
content:
application/json:
schema:
type: object
x-endpoint:
isEndpoint: false
auth:
middleware:
- auth.isAuthenticated
- auth.isAccountAdminAgents
postMiddleware:
- global.iseMiddleware
handler: runner-installation.reportInstallationProgressEvent
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 \"${REQUEST_BODY_OBJ}\" \\\n \"https://g.codefresh.io/api/runner-installation/${ID}\""
- lang: node.js
source: sdk.runner-installation.reportInstallationProgressEvent({ id }, { ...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-runner-installation-api-openapi.yml