openapi: 3.1.0
info:
title: Jenkins Remote Access Computer Queue API
description: Jenkins exposes a machine-consumable Remote Access API for nearly every resource it manages. The API is accessed by appending /api/ to any Jenkins resource URL (top-level Jenkins, jobs, builds, queue, computers, views). The API supports XML (with XPath filtering), JSON (with JSONP), and a Python-compatible variant. HTTP Basic authentication with API tokens is used for authenticated requests, and the X-Jenkins response header advertises the Jenkins version.
version: 1.0.0
contact:
name: Jenkins Project
url: https://www.jenkins.io/
license:
name: MIT
url: https://www.jenkins.io/license/
x-generated-from: https://www.jenkins.io/doc/book/using/remote-access-api/
x-generated-by: claude-crawl-2026-05-08
servers:
- url: https://{jenkinsHost}
description: Self-hosted Jenkins instance
variables:
jenkinsHost:
default: jenkins.example.com
description: Hostname (and optional port) of your Jenkins instance.
security:
- basicAuth: []
tags:
- name: Queue
description: The build queue.
paths:
/queue/api/json:
get:
tags:
- Queue
operationId: getQueue
summary: Get the current build queue
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Resource'
components:
schemas:
Resource:
type: object
additionalProperties: true
securitySchemes:
basicAuth:
type: http
scheme: basic
description: HTTP Basic auth using a Jenkins user and an API token.