# CloudBees Edge runners API

**Canonical:** https://apis.io/apis/cloudbees/cloudbees-edge-runners-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 Edge runners 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. This API exposes 4 JSON Schema definitions. Tagged areas include Edge runners. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, and 4 JSON Schemas.

Edge runners execute jobs on your own infrastructure rather than CloudBees-hosted systems, running builds and other work closer to private resources such as source control, artifact stores, and internal networks. Use these endpoints to register an edge runner in an organization and to list and inspect its available edge runners, the jobs they run, and each job's status.

## Operations (6)

| Method | Path | Summary |
|---|---|---|
| POST | `/v1/organizations/{organization_id}/edge/runner-token` | Create an edge runner registration token |
| GET | `/v1/organizations/{organization_id}/edge/runners` | List edge runners |
| GET | `/v1/organizations/{organization_id}/edge/runners/{runner_id}` | Get an edge runner |
| DELETE | `/v1/organizations/{organization_id}/edge/runners/{runner_id}` | Unregister an edge runner |
| GET | `/v1/organizations/{organization_id}/edge/jobs` | List edge jobs |
| GET | `/v1/organizations/{organization_id}/edge/jobs/{job_id}` | Get an edge job |

## Machine-readable artifacts (10)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cloudbees/refs/heads/main/openapi/cloudbees-edge-runners-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
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cloudbees/refs/heads/main/json-schema/cloudbees-api-v4-team-member-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cloudbees/refs/heads/main/json-schema/cloudbees-api-v4-list-team-memberships-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cloudbees/refs/heads/main/json-schema/cloudbees-api-v4-create-team-membership-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cloudbees/refs/heads/main/json-schema/cloudbees-api-v4-delete-team-membership-response-schema.json

## 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

Edge runners

---

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