# CloudBees Runs API

**Canonical:** https://apis.io/apis/cloudbees/cloudbees-runs-api/  
**Provider:** CloudBees — https://apis.io/providers/cloudbees/  
**Base URL:** https://example.cloudbees.com  
**Documentation:** https://docs.cloudbees.com/docs/cloudbees-ci-kb/latest/best-practices/best-practice-for-using-jenkins-rest-api

CloudBees Runs API is one of 23 APIs that [CloudBees](https://apis.io/providers/cloudbees/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Runs. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and authentication docs.

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

## Operations (13)

| Method | Path | Summary |
|---|---|---|
| POST | `/v4/components/{componentId}/runs` | Create run |
| PATCH | `/v4/components/{componentId}/runs/{run.id}` | Update run |
| GET | `/v4/components/{componentId}/runs/{runId}` | Get run |
| GET | `/v4/components/{componentId}/runs/{runId}/artifacts` | List artifacts |
| POST | `/v4/components/{componentId}/runs/{runId}/artifacts` | Attach artifacts |
| GET | `/v4/components/{componentId}/runs/{runId}/deployments` | List deployments |
| POST | `/v4/components/{componentId}/runs/{runId}/deployments` | Attach deployments |
| GET | `/v4/components/{componentId}/runs/{runId}/evidences` | List evidences |
| POST | `/v4/components/{componentId}/runs/{runId}/evidences` | Attach evidences |
| GET | `/v4/components/{componentId}/runs/{runId}/security-results` | List security results |
| POST | `/v4/components/{componentId}/runs/{runId}/security-results` | Attach security results |
| GET | `/v4/components/{componentId}/runs/{runId}/test-results` | List test results |
| POST | `/v4/components/{componentId}/runs/{runId}/test-results` | Attach test results |

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cloudbees/refs/heads/main/openapi/cloudbees-runs-api-openapi.yml
- **ToolCrosswalk** — https://raw.githubusercontent.com/api-evangelist/cloudbees/refs/heads/main/mcp/cloudbees-tool-crosswalk.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/cloudbees/refs/heads/main/data-model/cloudbees-data-model.yml
- **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

## Other CloudBees APIs (12)

- [CloudBees CI REST API](https://apis.io/apis/cloudbees/ci/)
- [CloudBees CD/RO REST API](https://apis.io/apis/cloudbees/cd-ro/)
- [CloudBees Feature Management REST API](https://apis.io/apis/cloudbees/feature-management/)
- [CloudBees CD/RO Jenkins Plugin Steps](https://apis.io/apis/cloudbees/jenkins-plugin/)
- [CloudBees Computer API](https://apis.io/apis/cloudbees/cloudbees-computer-api/)
- [CloudBees CreateItem API](https://apis.io/apis/cloudbees/cloudbees-createitem-api/)
- [CloudBees Job API](https://apis.io/apis/cloudbees/cloudbees-job-api/)
- [CloudBees Json API](https://apis.io/apis/cloudbees/cloudbees-json-api/)
- [CloudBees Python API](https://apis.io/apis/cloudbees/cloudbees-python-api/)
- [CloudBees Queue API](https://apis.io/apis/cloudbees/cloudbees-queue-api/)
- [CloudBees Xml API](https://apis.io/apis/cloudbees/cloudbees-xml-api/)
- [CloudBees Components API](https://apis.io/apis/cloudbees/cloudbees-components-api/)

## Tags

Runs

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/cloudbees/cloudbees-runs-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/cloudbees/.