CloudBees

CloudBees Runs API

Create, update, and retrieve CI/CD runs for a component. Attach and list test results, artifacts, security results, evidences, and deployments.

GitHub OpenAPI
Business capability
Continuous Integration Management BC-4210.10

Operations 13

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v4/components/{componentId}/runs Record a CI/CD run for a component · Create run #
Ask an LLM
“How do I report a pipeline run from an external CI tool?”
“Which CI/CD tools can a run be recorded from?”
Tell an agent
Record a run of workflow {workflowName} for component {componentId} on ref {scmRef} at commit {commitSha}.
Create a run for component {componentId} with status {status}, triggered by {actorName}, from {url}.
PATCH /v4/components/{componentId}/runs/{run.id} Update a run's status · Update run #
Ask an LLM
“How do I mark a run as finished or failed after it started?”
“Can I add a failure message to a run I already recorded?”
Tell an agent
Update run {runId} of component {componentId} to status {status}.
Set the end time of run {runId} in component {componentId} to {endedAt}.
GET /v4/components/{componentId}/runs/{runId} Get a run · Get run #
Ask an LLM
“How can I look up a single run and its status?”
“Who triggered a particular run and at which commit?”
Tell an agent
Get run {runId} of component {componentId}.
Show the status and trigger of run {runId} in component {componentId}.
GET /v4/components/{componentId}/runs/{runId}/artifacts List build artifacts on a run · List artifacts #
Ask an LLM
“What build artifacts were produced by a run?”
“Can I see the artifacts already attached to a run?”
Tell an agent
List the artifacts of run {runId} in component {componentId}.
Show build artifacts attached to run {runId} for component {componentId}.
POST /v4/components/{componentId}/runs/{runId}/artifacts Attach build artifacts to a run · Attach artifacts #
Ask an LLM
“How do I attach build artifacts, like container images, to a run?”
“Does attaching artifacts return IDs I can reference later?”
Tell an agent
Attach build artifacts to run {runId} of component {componentId}.
Add artifacts {artifacts} to run {runId} in component {componentId}.
GET /v4/components/{componentId}/runs/{runId}/deployments List deployments recorded on a run · List deployments #
Ask an LLM
“Which deployments are associated with a run?”
“Where was a run's output deployed?”
Tell an agent
List deployments for run {runId} of component {componentId}.
Show the deployments attached to run {runId} in component {componentId}.
POST /v4/components/{componentId}/runs/{runId}/deployments Record a deployment on a run · Attach deployments #
Ask an LLM
“How do I record that a run deployed artifacts to production?”
“Can I link existing build artifacts to a deployment in an environment?”
Tell an agent
Record a deployment of run {runId} in component {componentId} to environment {environment}.
Attach deployment of artifacts {artifactReferences} to {environment} for run {runId}, component {componentId}.
GET /v4/components/{componentId}/runs/{runId}/evidences List evidence attached to a run · List evidences #
Ask an LLM
“What compliance evidence has been attached to a run?”
“Can I review the evidence entries recorded for a run?”
Tell an agent
List the evidences for run {runId} of component {componentId}.
Show evidence attached to run {runId} in component {componentId}.
POST /v4/components/{componentId}/runs/{runId}/evidences Attach evidence to a run · Attach evidences #
Ask an LLM
“How do I attach evidence, such as approvals or checks, to a run?”
“Can I add several evidence entries to a run at once?”
Tell an agent
Attach evidence to run {runId} of component {componentId}.
Add evidences {evidences} to run {runId} in component {componentId}.
GET /v4/components/{componentId}/runs/{runId}/security-results List security findings for a run · List security results #
Ask an LLM
“What security vulnerabilities were found in a run's scans?”
“Can I see the processed security findings for a build?”
Tell an agent
List the security findings for run {runId} of component {componentId}.
Show processed scan results for run {runId} in component {componentId}.
POST /v4/components/{componentId}/runs/{runId}/security-results Attach security scan results to a run · Attach security results #
Ask an LLM
“How do I upload security scan reports for a run?”
“Can I attach several scanner reports to one run?”
Tell an agent
Attach security scan results to run {runId} of component {componentId}.
Upload scan reports {securityResults} to run {runId} in component {componentId}.
GET /v4/components/{componentId}/runs/{runId}/test-results Get download links for a run's test results · List test results #
Ask an LLM
“How do I download the test results files uploaded for a run?”
“Are test result files returned as download links?”
Tell an agent
Get download links for the test results of run {runId}, component {componentId}.
List test result files for run {runId} in component {componentId}.
POST /v4/components/{componentId}/runs/{runId}/test-results Upload test results to a run · Attach test results #
Ask an LLM
“How do I upload test results for a run?”
“Why don't uploaded test results show up right away after a 202 response?”
Tell an agent
Upload test results to run {runId} of component {componentId}.
Attach the test report file to run {runId} in component {componentId}.

Documentation

📖
APIReference
https://apidocs.cloudbees.io/
📖
Documentation
https://docs.cloudbees.com/docs/cloudbees-unify/latest/api-references/
📖
Authentication
https://docs.cloudbees.com/docs/cloudbees-platform/latest/workflows/personal-access-token

Specifications

⚙
OpenAPI
https://artifacts.apis.io/cloudbees/openapi/cloudbees-runs-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/cloudbees/json-schema/cloudbees-api-v4-run-schema.json
📊
JSONSchema
https://artifacts.apis.io/cloudbees/json-schema/cloudbees-api-v4-run-for-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/cloudbees/json-schema/cloudbees-api-v4-run-for-update-schema.json
📊
JSONSchema
https://artifacts.apis.io/cloudbees/json-schema/cloudbees-api-v4-create-deployment-artifacts-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/cloudbees/json-schema/cloudbees-api-v4-create-run-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/cloudbees/json-schema/cloudbees-api-v4-create-deployment-artifacts-response-schema.json

Other Resources

🔗
ToolCrosswalk
https://artifacts.apis.io/cloudbees/mcp/cloudbees-tool-crosswalk.yml
🔗
DataModel
https://artifacts.apis.io/cloudbees/data-model/cloudbees-data-model.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/cloudbees:cloudbees-runs-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

cloudbees-runs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: CloudBees Unify API (Current) Runs API
  version: 1.0.0
  description: 'API documentation for CloudBees Unify''s current, stable endpoints. This specification covers the endpoints customers rely on today while next-generation v4 equivalents are in development. These endpoints are stable and supported, but no longer receive new features.


    ### Unify core


    #### Components

    List components within an organization, and optionally filter by component type, such as applications or services with an associated repository.


    #### Environments

    Discover and manage environments within your organization. Use environments to maintain an up-to-date inventory for feature flag targeting, deployment scripts, and monitoring workflows.


    #### Organizations

    Define the structural and governance boundaries within a CloudBees Unify tenant. Organizations model business units or departments, support parent-child hierarchies, and inherit configuration—properties, integrations, and environments—from parent organizations. Every tenant has one root organization; all others exist beneath it.


    #### Runs

    Create, update, and retrieve CI/CD runs for a component. Attach and list test results, artifacts, security results, evidences, and deployments.


    #### Teams

    List teams within an organization. Teams group users to manage access and permissions across resources in CloudBees Unify.


    #### Users

    Invite or remove users, and define custom attributes for feature flag targeting based on application-specific criteria such as account tier, region, or subscription status.


    ### Feature management


    #### Flags

    Control runtime feature visibility and behavior to enable gradual rollouts, A/B testing, progressive delivery, and safe deployments without redeployment.


    #### Flag configurations

    Set flag state (enabled or disabled) and targeting rules for a specific environment to determine which users or segments receive each variation.


    #### Flag custom properties

    Create, read, update, and delete custom properties used in targeting conditions and target groups.


    #### Target groups

    Define reusable sets of targeting conditions for feature flags. Specify rules once (such as matching users by role, region, or custom property) and apply them across multiple flags. Changes to a target group propagate automatically to every flag that references it.


    #### Flag lifecycle

    Track how often each flag variation is served in an environment. Use impression data to monitor adoption, validate rollouts, and see which variations your application evaluates.


    For new integrations, prefer the CloudBees Unify API (Beta) where available.'
servers:
- url: https://api.cloudbees.io
  description: CloudBees Unify Production API
security:
- BearerAuth: []
tags:


# --- truncated at 32 KB (41 KB total) ---
# Full source: https://artifacts.apis.io/cloudbees/openapi/cloudbees-runs-api-openapi.yml