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 Computer API

Connected build agents.

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

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

This API exposes 1 operation across 1 path, 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}.

1 operations 1 paths 1 schemas 1 GET

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 Computer 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Computer 1

Connected build agents.

GET
/computer/api/json
List connected agents
listComputers → 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-computer-api-openapi.yml Raw ↑

Other APIs Jenkins publishes across the network.

Jenkins Jobs API
Jenkins Queue API
Jenkins Server API