# CloudBees Components API

**Canonical:** https://apis.io/apis/cloudbees/cloudbees-components-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 Components 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 Components. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and authentication docs.

Create and manage the components in an organization. A component represents a source code repository that CloudBees Unify tracks. Components can be onboarded with or without an SCM integration, and an existing component can be connected to an integration later.

## Operations (6)

| Method | Path | Summary |
|---|---|---|
| GET | `/v4/organizations/{orgId}/components` | List components |
| POST | `/v4/organizations/{orgId}/components` | Create component |
| GET | `/v4/organizations/{orgId}/components/{id}` | Get component |
| DELETE | `/v4/organizations/{orgId}/components/{id}` | Delete component |
| PATCH | `/v4/organizations/{orgId}/components/{id}` | Update component |
| GET | `/v1/organizations/{orgId}/services` | List applications and components |

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cloudbees/refs/heads/main/openapi/cloudbees-components-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 Environments API](https://apis.io/apis/cloudbees/cloudbees-environments-api/)

## Tags

Components

---

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