Docs · static mirror — the interactive version loads with JavaScript.

Jenkins

Source: https://runstack.engineer/docs/toolkits/jenkins

Jobs, builds, console logs, queues, agents, views, and plugins via the Jenkins Remote Access API.

Tools (32):

ToolDescription
jenkinsListJobsList jobs on the Jenkins controller with name, status color and build state. Use first to discover job names.
jenkinsGetJobGet details of a Jenkins job: description, disabled state, health reports and recent builds.
jenkinsGetJobConfigGet the raw config.xml of a Jenkins job to read SCM, triggers and builder configuration.
jenkinsCreateJobCreate a new Jenkins job from a config.xml document.
jenkinsCopyJobCopy an existing Jenkins job to a new name instead of hand-writing config.xml.
jenkinsUpdateJobConfigUpdate a Jenkins job by replacing its config.xml with a full replacement document.
jenkinsEnableJobEnable a disabled Jenkins job so it can be built and triggered again.
jenkinsDisableJobDisable a Jenkins job so no new builds are scheduled (running builds continue).
jenkinsDeleteJobPermanently delete a Jenkins job and all of its builds and artifacts.
jenkinsListBuildsList recent builds of a Jenkins job with number, result, building state and duration.
jenkinsGetBuildGet details of a single Jenkins build: result, duration, artifacts, change sets and culprits.
jenkinsGetLastBuildGet a symbolic build of a job (lastBuild, lastSuccessfulBuild, lastFailedBuild, lastCompletedBuild, lastStableBuild) without knowing its number.
jenkinsGetConsoleLogGet the full console output of a Jenkins build to diagnose failures.
jenkinsGetProgressiveLogPage through a Jenkins build log with the progressiveText API; also works for live-tailing running builds.
jenkinsGetTestReportGet the aggregated JUnit test report of a Jenkins build with pass/fail/skip counts.
jenkinsTriggerBuildTrigger a new build of a Jenkins job without parameters. Returns the queue item URL for tracking.
jenkinsTriggerParameterizedBuildTrigger a new build of a parameterized Jenkins job with a key-value parameter map.
jenkinsStopBuildAbort a running Jenkins build (marked ABORTED, kept in history).
jenkinsDeleteBuildPermanently delete a single Jenkins build with its log, artifacts and test results.
jenkinsGetServerInfoGet Jenkins controller info: version, jobs/views overview and executor counts. Use to verify connectivity.
jenkinsListQueueList items waiting in the Jenkins build queue with reason, ETA and task.
jenkinsGetQueueItemGet a single Jenkins queue item: wait reason, ETA and the started build URL once assigned.
jenkinsCancelQueueItemCancel a waiting Jenkins build queue item so it never starts.
jenkinsListNodesList Jenkins agents/nodes with offline state, executor counts and load statistics.
jenkinsGetNodeGet details of a single Jenkins agent: executors, monitor data and offline cause.
jenkinsListViewsList views (tabs) configured on the Jenkins controller.
jenkinsGetViewGet a Jenkins view with the jobs it contains and their status colors.
jenkinsListPluginsList plugins installed on the Jenkins controller with version and enabled state.
jenkinsGetCurrentUserGet the Jenkins user the credentials authenticate as. Use to verify an API token.
jenkinsQuietDownPut Jenkins into quiet-down mode: running builds finish, no new builds start.
jenkinsCancelQuietDownCancel quiet-down mode so Jenkins accepts new builds again.
jenkinsSafeRestartSafely restart Jenkins after running jobs finish.