Jenkins Server API
Information about the Jenkins instance.
Jenkins Server API is one of 4 APIs that Jenkins publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Server. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 2 operations across 2 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}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Jenkins Server 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 2
Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.
Information about the Jenkins instance.
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.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Jenkins 3
Other APIs Jenkins publishes across the network.