Service Overview
Jenkins Remote API is the official continuous integration and automation api from Jenkins for ci, builds, jobs, and automation. This Hub entry keeps the service explanation, setup links, and Harbor-safe import path together so operators can review the integration before local credentials and policies are applied.
Jenkins Remote API
Service
Continuous integration and automation API
Service type
https://your-jenkins.example.com/
Base URL
What This Port Does
- List Jenkins jobs using the controller root API with a bounded field selection and optional depth control.
- Fetch a bounded Jenkins build record for a known top-level job and build reference.
- Trigger a known Jenkins job without parameters using an explicit top-level job path.
- Keeps service credentials local to Harbor Node so approval, execution, and audit stay inside the Harbor ecosystem.
Operator Setup
- Create or confirm a Jenkins account, workspace, or tenant with the API access needed for the actions you plan to enable.
- Import this Hub entry into Harbor, then replace the starter base URL with your tenant-specific service URL before testing actions.
- Store the required Basic token locally in Harbor Node using the Authorization header, then review automatic versus approval-required actions before publish.
- Use the vendor setup guide linked below to create service credentials, scopes, or app registration settings that match your Harbor policy.
Install
Use in Harbor UI or the import-by-URL route.
https://hub.breakwaterharbor.net/p/jenkins/jenkins-remote-api
http_api
Local shell
7
Actions
Community
Required tier
Never
Secrets imported
Actions
List Jobs JSON
{
"slug": "list-jobs",
"label": "List Jobs",
"description": "List Jenkins jobs using the controller root API with a bounded field selection and optional depth control.",
"method": "GET",
"path": "/api/json",
"inputs": {
"parameters": [
{
"name": "depth",
"in": "query",
"schema": {
"type": "integer",
"minimum": 0,
"maximum": 2
},
"default": 1,
"description": "Optional Jenkins API depth. Keep this low to avoid overly large controller responses."
}
],
"staticQuery": {
"tree": "jobs[name,url,color,lastBuild[number,url,result,timestamp],lastSuccessfulBuild[number,url],lastFailedBuild[number,url]],views[name,url]"
}
},
"approvalMode": "automatic",
"requestBodyMode": "none",
"resultMode": "json_summary"
}
Workflows
Job Health Check And Trigger
Future workflow template for listing jobs, checking a recent build, and operator-reviewed triggering of a known Jenkins job.