Jenkins

Jenkins Remote Access API

Jenkins provides a machine-consumable Remote Access API to nearly every resource it exposes. The API is reached by appending /api/ to any Jenkins resource URL (top-level, jobs, builds, queue, nodes, views, etc.), is available in XML, JSON (JSONP), and Python variants, and supports authenticated requests via HTTP Basic auth with API tokens. Common operations include triggering builds, retrieving job and build information, and inspecting build queues, with depth and tree query parameters for controlling response shape.

GitHub

Documentation

📖
Documentation
https://www.jenkins.io/doc/book/using/remote-access-api/
📖
Authentication
https://www.jenkins.io/doc/book/system-administration/authenticating-scripted-clients/

Other Resources

🔗
APITokens
https://www.jenkins.io/doc/book/managing/system-configuration/#configuring-api-tokens

API entry from apis.yml

apis.yml Raw ↑ 
aid: jenkins:jenkins-remote-access-api
name: Jenkins Remote Access API
description: Jenkins provides a machine-consumable Remote Access API to nearly every resource it exposes.
  The API is reached by appending /api/ to any Jenkins resource URL (top-level, jobs, builds, queue, nodes,
  views, etc.), is available in XML, JSON (JSONP), and Python variants, and supports authenticated requests
  via HTTP Basic auth with API tokens. Common operations include triggering builds, retrieving job and
  build information, and inspecting build queues, with depth and tree query parameters for controlling
  response shape.
humanURL: https://www.jenkins.io/doc/book/using/remote-access-api/
tags:
- JSON
- Python
- Remote Access
- REST API
- XML
properties:
- type: Documentation
  url: https://www.jenkins.io/doc/book/using/remote-access-api/
- type: Authentication
  url: https://www.jenkins.io/doc/book/system-administration/authenticating-scripted-clients/
- type: APITokens
  url: https://www.jenkins.io/doc/book/managing/system-configuration/#configuring-api-tokens