How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Jenkins

Jenkins is the leading open source automation server, providing hundreds of plugins for building, deploying, and automating software projects. Jenkins exposes a remote access REST API that supports XML, JSON, and Python representations and is the de facto standard automation engine for many organizations.

Jenkins is one of 8 APIs that Continuous Delivery Foundation publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Automation, CI/CD, Jenkins, Pipelines, and REST. The published artifact set on APIs.io includes API documentation, a getting-started guide, an OpenAPI specification, and a changelog.

This API exposes 10 operations across 10 paths, organized into 2 resource areas, and defines 14 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: {build_url}/stages, {job_url}/multi-pipeline-graph.

10 operations 10 paths 14 schemas 8 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Servers
{build_url}/stages
{job_url}/multi-pipeline-graph
Authentication
HTTP Basic
Resource Areas
2

Authentication & Security 1

Jenkins declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (jenkins_auth).

  • jenkins_auth — Jenkins basic authentication

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 8 GET, 2 POST. They span 2 resource areas: Pipeline Overview, Multi-Pipeline Graph. Each is listed below with its method, path, parameters, and response codes.

Pipeline Overview 9

APIs for individual pipeline run visualization and control

GET
/tree
Get pipeline stage tree
getPipelineTree → 200500
GET
/allSteps
Get all pipeline steps
getAllSteps → 200500
GET
/steps
Get steps for a specific node
getStepsByNode 1 param → 200400
GET
/exceptionText
Get exception text of a failed step
getExceptionText 1 param → 200400
GET
/log
Get raw console text
getConsoleText 1 param → 200400
GET
/consoleBuildOutput
Get full build console output
getBuildConsoleOutput → 200
GET
/nextBuild
Check for next build
hasNextBuild 1 param → 200400
POST
/doRerun
Rerun the pipeline
rerunPipeline → 200403400
POST
/doCancel
Cancel the running pipeline
cancelPipeline → 200403400
Multi-Pipeline Graph 1

APIs for viewing multiple pipeline runs

GET
/runs
Get recent pipeline runs
getPipelineRuns 1 param → 200304

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are PipelineStage (17 properties), PipelineStep (10 properties), PipelineRun (6 properties), InputStep (5 properties). Each schema is shown below with its type and property counts.

PipelineTreeResponse
object
2 properties
PipelineGraph
object
2 properties
PipelineStage
object
17 properties
PipelineState
string
StepListResponse
object
2 properties
StepList
object
2 properties
PipelineStep
object
10 properties
InputStep
object
5 properties
NextBuildResponse
object
2 properties
RerunResponse
object
2 properties
PipelineRunsResponse
object
2 properties
PipelineRun
object
6 properties
SuccessResponse
object
2 properties
ErrorResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

continuous-delivery-foundation-jenkins-pipeline-graph-view-openapi.yaml Raw ↑

Other APIs Continuous Delivery Foundation publishes across the network.

CDEvents Specification
Spinnaker
Screwdriver
Ortelius
CD Foundation Content API
Where this information came from

This is an independent, third-party profile of Jenkins, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.