Jenkins API

Self-hosted automation server for CI/CD pipelines and plugin ecosystem.

Quick Facts

Overview

Jenkins API is a devops & infrastructure apis provided by Jenkins. Self-hosted automation server for CI/CD pipelines and plugin ecosystem. This API is designed to help developers integrate devops capabilities into their applications with minimal setup and maximum reliability.

The API supports API Token authentication, ensuring secure access to all endpoints. With a open-source pricing model, Jenkins offers flexible options for projects of any size, from prototypes to enterprise deployments.

Jenkins maintains comprehensive documentation, SDKs for popular programming languages, and active community support. The API is built on REST principles, returning JSON responses with standard HTTP status codes, making it straightforward to integrate into existing workflows.

Authentication

This API uses API Token authentication. Send your API token in the Authorization header or a custom header depending on the API.

Always store your credentials securely using environment variables or a secrets manager. Never commit API keys to version control or expose them in client-side code.

Code Samples

Python

import requests
import os

API_KEY = os.environ.get("API_KEY", "YOUR_API_KEY")
BASE_URL = "https://api.jenkins.io"

headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json"
}

response = requests.get(f"{BASE_URL}/v1/resources", headers=headers)
print(response.status_code)
print(response.json())

JavaScript

const API_KEY = process.env.API_KEY || 'YOUR_API_KEY';
const BASE_URL = 'https://api.jenkins.io';

const response = await fetch(`${BASE_URL}/v1/resources`, {
  headers: {
    'Authorization': `Bearer ${API_KEY}`,
    'Content-Type': 'application/json'
  }
});
const data = await response.json();
console.log(data);

cURL

curl -H "Authorization: Bearer $API_KEY" \
     -H "Content-Type: application/json" \
     https://api.jenkins.io/v1/resources

Go

package main

import (
    "net/http"
    "fmt"
    "io"
    "os"
)

func main() {
    apiKey := os.Getenv("API_KEY")
    if apiKey == "" {
        apiKey = "YOUR_API_KEY"
    }
    req, _ := http.NewRequest("GET", "https://api.jenkins.io/v1/resources", nil)
    req.Header.Set("Authorization", "Bearer " + apiKey)
    req.Header.Set("Content-Type", "application/json")
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

Pricing

The pricing model is open-source. Open-source software you can self-host for free, with paid managed cloud options. Visit the provider’s pricing page at https://jenkins.io for current rates and detailed pricing information.

Use Cases

• Integration: Connect Jenkins services to your application for seamless devops functionality.
• Automation: Automate devops workflows and reduce manual operations.
• Scaling: Handle growing devops demands with Jenkins’s robust infrastructure.

Related APIs

• GitHub API
• GitLab API
• Vercel API
• Netlify API
• Cloudflare Workers API

Further Reading

• Integration Guide
• FAQ
• Glossary