Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Jenkins Jobs API

Jenkins jobs and their builds.

Jenkins Jobs API is one of 4 APIs that Jenkins publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Jobs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 4 operations across 4 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://{jenkinsHost}.

4 operations 4 paths 1 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
https://{jenkinsHost}
Authentication
HTTP Basic
License
Resource Areas
1

Authentication & Security 1

Jenkins Jobs API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic auth using a Jenkins user and an API token.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Jobs 4

Jenkins jobs and their builds.

GET
/job/{jobName}/api/json
Get information about a job (JSON)
getJob 3 params → 200
POST
/job/{jobName}/build
Trigger a build for a parameterless job
triggerBuild 2 params → 201200
POST
/job/{jobName}/buildWithParameters
Trigger a build with parameters
triggerBuildWithParameters 1 param body → 201200
GET
/job/{jobName}/{buildNumber}/api/json
Get information about a specific build
getBuild 3 params → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

Resource
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jenkins-jobs-api-openapi.yml Raw ↑

Other APIs Jenkins publishes across the network.

Jenkins Computer API
Jenkins Queue API
Jenkins Server API