CloudBees website screenshot

CloudBees

CloudBees provides software delivery automation across continuous integration, continuous deployment, release orchestration, and feature management. Their developer surface includes the CloudBees CI REST API (an extension of the Jenkins REST API), the CloudBees CD/RO REST API for release orchestration, the CloudBees Feature Management REST API (formerly Rollout) for feature flags and environments, and the CloudBees Unify Platform API for the modern unified delivery platform. APIs are generally JSON, token-authenticated, and follow REST conventions.

5 APIs 0 Features
CI/CDContinuous DeliveryContinuous IntegrationDevOpsFeature FlagsFeature ManagementJenkinsRelease OrchestrationSoftware Delivery

APIs

CloudBees CI REST API

CloudBees CI is a hardened, enterprise distribution of Jenkins. The REST API is the Jenkins remote access API exposed at /api on every controller and on individual jobs, runs, q...

CloudBees CD/RO REST API

The CloudBees CD/RO (Continuous Delivery / Release Orchestration) REST API exposes resources for pipelines, releases, environments, applications, deployments, projects and resou...

CloudBees Feature Management REST API

The CloudBees Feature Management REST API (formerly Rollout) provides programmatic access to applications, environments, feature flags, experiments, target groups, audit logs, a...

CloudBees Unify Platform API

CloudBees Unify is the modern, opinionated software delivery platform that unifies CI, CD, feature management, analytics, and security into a single workflow. The platform expos...

CloudBees CD/RO Jenkins Plugin Steps

The CloudBees CD plugin for Jenkins exposes Jenkins pipeline steps that call CloudBees CD/RO REST endpoints — triggering pipelines, running releases, deploying applications, and...

Collections

CloudBees CI REST API (Jenkins-compatible)

OPEN

Pricing Plans

Cloudbees Plans Pricing

3 plans

PLANS

Rate Limits

Cloudbees Rate Limits

5 limits

RATE LIMITS

FinOps

Cloudbees Finops

FINOPS

Semantic Vocabularies

Cloudbees Context

0 classes · 11 properties

JSON-LD

API Governance Rules

CloudBees API Rules

12 rules · 4 errors 6 warnings 2 info

SPECTRAL

Resources

👥
GitHubOrganization
GitHubOrganization
🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Documentation
Documentation
💬
Support
Support
📜
PrivacyPolicy
PrivacyPolicy
🔗
Plugins
Plugins
🔗
JSONLD
JSONLD
🔗
Spectral
Spectral

Sources

apis.yml Raw ↑ 
opencollection: 1.0.0
info:
  name: CloudBees CI REST API (Jenkins-compatible)
  version: 1.0.0
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{password}}'
items:
- info:
    name: Get controller (top-level) metadata
    type: http
  http:
    method: GET
    url: https://example.cloudbees.com/api/json
    params:
    - name: tree
      value: ''
      type: query
      description: 'Tree filter for selecting and trimming response fields.

        Example: `jobs[name,url,color]`.

        '
    - name: depth
      value: ''
      type: query
    - name: pretty
      value: ''
      type: query
  docs: Get controller (top-level) metadata
- info:
    name: Get controller metadata as XML
    type: http
  http:
    method: GET
    url: https://example.cloudbees.com/api/xml
    params:
    - name: xpath
      value: ''
      type: query
    - name: tree
      value: ''
      type: query
      description: 'Tree filter for selecting and trimming response fields.

        Example: `jobs[name,url,color]`.

        '
    - name: depth
      value: ''
      type: query
  docs: Get controller metadata as XML
- info:
    name: Get controller metadata as Python literal
    type: http
  http:
    method: GET
    url: https://example.cloudbees.com/api/python
    params:
    - name: tree
      value: ''
      type: query
      description: 'Tree filter for selecting and trimming response fields.

        Example: `jobs[name,url,color]`.

        '
    - name: depth
      value: ''
      type: query
  docs: Get controller metadata as Python literal
- info:
    name: Get job metadata
    type: http
  http:
    method: GET
    url: https://example.cloudbees.com/job/:name/api/json
    params:
    - name: name
      value: ''
      type: path
    - name: tree
      value: ''
      type: query
      description: 'Tree filter for selecting and trimming response fields.

        Example: `jobs[name,url,color]`.

        '
    - name: depth
      value: ''
      type: query
  docs: Get job metadata
- info:
    name: Trigger a build (no parameters)
    type: http
  http:
    method: POST
    url: https://example.cloudbees.com/job/:name/build
    params:
    - name: name
      value: ''
      type: path
    - name: token
      value: ''
      type: query
  docs: Trigger a build (no parameters)
- info:
    name: Trigger a parameterized build
    type: http
  http:
    method: POST
    url: https://example.cloudbees.com/job/:name/buildWithParameters
    params:
    - name: name
      value: ''
      type: path
    - name: token
      value: ''
      type: query
    body:
      type: form-urlencoded
      data: []
  docs: Trigger a parameterized build
- info:
    name: Get a specific build
    type: http
  http:
    method: GET
    url: https://example.cloudbees.com/job/:name/:number/api/json
    params:
    - name: name
      value: ''
      type: path
    - name: number
      value: ''
      type: path
    - name: tree
      value: ''
      type: query
      description: 'Tree filter for selecting and trimming response fields.

        Example: `jobs[name,url,color]`.

        '
  docs: Get a specific build
- info:
    name: Get last successful build of a job
    type: http
  http:
    method: GET
    url: https://example.cloudbees.com/job/:name/lastSuccessfulBuild/api/json
    params:
    - name: name
      value: ''
      type: path
    - name: tree
      value: ''
      type: query
      description: 'Tree filter for selecting and trimming response fields.

        Example: `jobs[name,url,color]`.

        '
  docs: Get last successful build of a job
- info:
    name: Get build queue
    type: http
  http:
    method: GET
    url: https://example.cloudbees.com/queue/api/json
    params:
    - name: tree
      value: ''
      type: query
      description: 'Tree filter for selecting and trimming response fields.

        Example: `jobs[name,url,color]`.

        '
  docs: Get build queue
- info:
    name: List nodes/agents
    type: http
  http:
    method: GET
    url: https://example.cloudbees.com/computer/api/json
    params:
    - name: tree
      value: ''
      type: query
      description: 'Tree filter for selecting and trimming response fields.

        Example: `jobs[name,url,color]`.

        '
    - name: depth
      value: ''
      type: query
  docs: List nodes/agents
- info:
    name: Create a new job (item)
    type: http
  http:
    method: POST
    url: https://example.cloudbees.com/createItem
    params:
    - name: name
      value: ''
      type: query
  docs: Create a new job (item)
- info:
    name: Get job configuration XML
    type: http
  http:
    method: GET
    url: https://example.cloudbees.com/job/:name/config.xml
    params:
    - name: name
      value: ''
      type: path
  docs: Get job configuration XML
- info:
    name: Update job configuration XML
    type: http
  http:
    method: POST
    url: https://example.cloudbees.com/job/:name/config.xml
    params:
    - name: name
      value: ''
      type: path
  docs: Update job configuration XML
- info:
    name: Delete job
    type: http
  http:
    method: POST
    url: https://example.cloudbees.com/job/:name/doDelete
    params:
    - name: name
      value: ''
      type: path
  docs: Delete job
bundled: true