CloudBees

CloudBees Json API

The Json API from CloudBees — 1 operation(s) for json.

Documentation GitHub OpenAPI

Operations 1

GET /api/json Get controller (top-level) metadata

Specifications

⚙

OpenAPI

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

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

openapi: 3.2.0
info:
  title: CloudBees CI REST API (Jenkins-compatible) Computer JSON 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: Json
paths:
  /api/json:
    get:
      summary: Get controller (top-level) metadata
      parameters:
      - $ref: '#/components/parameters/Tree'
      - $ref: '#/components/parameters/Depth'
      - $ref: '#/components/parameters/Pretty'
      responses:
        '200':
          description: Controller metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Jenkins'
      tags:
      - Json
components:
  schemas:
    JobSummary:
      type: object
      properties:
        _class:
          type: string
        name:
          type: string
        url:
          type: string
        color:
          type: string
    Jenkins:
      type: object
      properties:
        _class:
          type: string
        mode:
          type: string
        nodeName:
          type: string
        numExecutors:
          type: integer
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/JobSummary'
        views:
          type: array
          items:
            type: object
  parameters:
    Tree:
      name: tree
      in: query
      description: 'Tree filter for selecting and trimming response fields.

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

        '
      schema:
        type: string
    Depth:
      name: depth
      in: query
      schema:
        type: integer
        default: 0
    Pretty:
      name: pretty
      in: query
      schema:
        type: boolean
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Jenkins username + API token