CloudBees

CloudBees Job API

The Job API from CloudBees — 7 operation(s) for job.

GitHub OpenAPI
Business capability
Continuous Integration Management BC-4210.10

Operations 8

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

GET /job/{name}/api/json Get a job's metadata and build history · Get job metadata #
Ask an LLM
“How do I see a job's status and recent builds in CloudBees CI?”
“Is my job currently healthy, and what was its last build result?”
Tell an agent
Show the metadata for job {name}.
Get job {name}'s details, returning only {tree}.
POST /job/{name}/build Start a build of a job with no parameters · Trigger a build (no parameters) #
Ask an LLM
“How do I kick off a job that takes no build parameters?”
“Can I trigger a plain build remotely using a job's trigger token?”
Tell an agent
Start a build of job {name} with no parameters.
Trigger a plain build of {name} using the remote token {token}.
POST /job/{name}/buildWithParameters Start a parameterized build of a job · Trigger a parameterized build #
Ask an LLM
“How do I run a job and pass it build parameters?”
“Can I launch a parameterized build remotely with a trigger token?”
Tell an agent
Run job {name} with the build parameters I give you.
Launch a parameterized build of {name} authorized by token {token}.
GET /job/{name}/{number}/api/json Get a specific build of a job by number · Get a specific build #
Ask an LLM
“What was the result of a particular numbered build of my job?”
“Can I look up how long build #42 took and who started it?”
Tell an agent
Show build {number} of job {name}.
Get build number {number} of {name}, returning only {tree}.
GET /job/{name}/lastSuccessfulBuild/api/json Get the last successful build of a job · Get last successful build of a job #
Ask an LLM
“When did my job last pass, and which build was it?”
“Which build of this job was the most recent green one?”
Tell an agent
Show the last successful build of job {name}.
Get {name}'s most recent passing build, limited to {tree}.
GET /job/{name}/config.xml Download a job's configuration XML · Get job configuration XML #
Ask an LLM
“How do I export a job's config.xml so I can back it up?”
“Where can I read the raw XML definition of an existing job?”
Tell an agent
Download the config.xml of job {name}.
Show me the current XML configuration for {name}.
POST /job/{name}/config.xml Replace a job's configuration XML · Update job configuration XML #
Ask an LLM
“How do I change an existing job's settings by uploading new config XML?”
“Can I push an edited config.xml back to a job?”
Tell an agent
Overwrite job {name}'s configuration with the XML I provide.
Upload this edited config.xml to job {name}.
POST /job/{name}/doDelete Delete a job · Delete job #
Ask an LLM
“How do I permanently remove a job from the controller?”
“Can I delete an obsolete job through the API?”
Tell an agent destructive · confirm first
Delete job {name} from the controller.
Permanently remove the obsolete {name} job.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cloudbees/refs/heads/main/openapi/cloudbees-job-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudbees/refs/heads/main/json-schema/cloudbees-job-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudbees/refs/heads/main/json-schema/cloudbees-build-schema.json

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-job-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-job-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: CloudBees CI REST API (Jenkins-compatible) Job API
  description: 'CloudBees CI exposes the Jenkins remote-access REST API for inspecting and

    controlling jobs, builds, queues, and computers. Append `/api/json`,

    `/api/xml`, or `/api/python` to any URL on the controller to retrieve

    machine-readable metadata. Use the `tree` query parameter to limit the

    payload (recommended for performance). Authenticate with an API token via

    HTTP Basic Auth.'
  version: 1.0.0
servers:
- url: https://example.cloudbees.com
  description: CloudBees CI controller (replace with your JENKINS_URL)
security:
- basicAuth: []
tags:
- name: Job
paths:
  /job/{name}/api/json:
    get:
      summary: Get job metadata
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/Tree'
      - $ref: '#/components/parameters/Depth'
      responses:
        '200':
          description: Job metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
      tags:
      - Job
      operationId: getJobByNameApiJson
      x-operation-id-source: derived
  /job/{name}/build:
    post:
      summary: Trigger a build (no parameters)
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - name: token
        in: query
        schema:
          type: string
      responses:
        '201':
          description: Build queued
        '400':
          description: Bad request (job requires parameters)
      tags:
      - Job
      operationId: postJobByNameBuild
      x-operation-id-source: derived
  /job/{name}/buildWithParameters:
    post:
      summary: Trigger a parameterized build
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - name: token
        in: query
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties:
                type: string
      responses:
        '201':
          description: Build queued
      tags:
      - Job
      operationId: postJobByNameBuildWithParameters
      x-operation-id-source: derived
  /job/{name}/{number}/api/json:
    get:
      summary: Get a specific build
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - name: number
        in: path
        required: true
        schema:
          type: integer
      - $ref: '#/components/parameters/Tree'
      responses:
        '200':
          description: Build metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Build'
      tags:
      - Job
      operationId: getJobByNameByNumberApiJson
      x-operation-id-source: derived
  /job/{name}/lastSuccessfulBuild/api/json:
    get:
      summary: Get last successful build of a job
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/Tree'
      responses:
        '200':
          description: Build metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Build'
      tags:
      - Job
      operationId: getJobByNameLastSuccessfulBuildApiJson
      x-operation-id-source: derived
  /job/{name}/config.xml:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Get job configuration XML
      responses:
        '200':
          description: config.xml
          content:
            application/xml:
              schema:
                type: string
      tags:
      - Job
      operationId: getJobByNameConfigXml
      x-operation-id-source: derived
    post:
      summary: Update job configuration XML
      requestBody:
        required: true
        content:
          application/xml:
            schema:
              type: string
      responses:
        '200':
          description: Updated
      tags:
      - Job
      operationId: postJobByNameConfigXml
      x-operation-id-source: derived
  /job/{name}/doDelete:
    post:
      summary: Delete job
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Deleted
      tags:
      - Job
      operationId: postJobByNameDoDelete
      x-operation-id-source: derived
components:
  parameters:
    Depth:
      name: depth
      in: query
      schema:
        type: integer
        default: 0
    Tree:
      name: tree
      in: query
      description: 'Tree filter for selecting and trimming response fields.

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

        '
      schema:
        type: string
  schemas:
    Build:
      type: object
      properties:
        _class:
          type: string
        number:
          type: integer
        result:
          type: string
        duration:
          type: integer
        timestamp:
          type: integer
        url:
          type: string
    BuildSummary:
      type: object
      properties:
        number:
          type: integer
        url:
          type: string
    Job:
      type: object
      properties:
        _class:
          type: string
        name:
          type: string
        url:
          type: string
        builds:
          type: array
          items:
            $ref: '#/components/schemas/BuildSummary'
        lastBuild:
          $ref: '#/components/schemas/BuildSummary'
        lastSuccessfulBuild:
          $ref: '#/components/schemas/BuildSummary'
        buildable:
          type: boolean
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Jenkins username + API token