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.
openapi: 3.2.0
info:
title: CloudBees CI REST API (Jenkins-compatible) Computer XML 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: Xml
paths:
/api/xml:
get:
summary: Get controller metadata as XML
parameters:
- $ref: '#/components/parameters/XPath'
- $ref: '#/components/parameters/Tree'
- $ref: '#/components/parameters/Depth'
responses:
'200':
description: XML controller metadata
content:
application/xml:
schema:
type: string
tags:
- Xml
components:
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
XPath:
name: xpath
in: query
schema:
type: string
securitySchemes:
basicAuth:
type: http
scheme: basic
description: Jenkins username + API token