{"id":528,"date":"2017-02-24T12:14:09","date_gmt":"2017-02-24T12:14:09","guid":{"rendered":"http:\/\/www.scmgalaxy.com\/tutorials\/2017\/02\/24\/jenkins-remote-access-api-example\/"},"modified":"2021-11-19T06:09:34","modified_gmt":"2021-11-19T06:09:34","slug":"jenkins-remote-access-api-example","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/jenkins-remote-access-api-example\/","title":{"rendered":"Jenkins Remote access API Example | Jenkins Tutorial"},"content":{"rendered":"
\"jenkins-remote-access-api-example\"<\/div>\n
<\/div>\n
Jenkins Remote access API Example<\/strong><\/div>\n
<\/div>\n
Jenkins provides machine-consumable remote access API to its functionalities. Currently it comes in three flavors:<\/strong><\/div>\n
<\/div>\n
XML<\/div>\n
JSON with JSONP support<\/div>\n
Python<\/div>\n
<\/div>\n
Remote access API is offered in a REST-like style. That is, there is no single entry point for all features, and instead they are available under the “…\/api\/” URL where “…” portion is the data that it acts on.<\/div>\n
<\/div>\n
For example, if your Jenkins installation sits at http:\/\/ci.jruby.org\/, visiting http:\/\/ci.jruby.org\/api\/ will show just the top-level API features available \u2013 primarily a listing of the configured jobs for this Jenkins instance.<\/div>\n
<\/div>\n
Or if you want to access information about a particular build, e.g. http:\/\/ci.jruby.org\/job\/jruby-base\/lastSuccessfulBuild\/, then go to http:\/\/ci.jruby.org\/job\/jruby-base\/lastSuccessfulBuild\/api\/ and you’ll see the list of functionalities for that build.<\/div>\n
<\/div>\n
Remote API can be used to do things like these:<\/strong><\/div>\n
<\/div>\n
Retrieve information from Jenkins for programmatic consumption.<\/div>\n
trigger a new build<\/div>\n
create\/copy jobs<\/div>\n
<\/div>\n
<\/div>\n
Jobs with parameters, Also see Parameterized Build.<\/div>\n
Simple example – sending “String Parameters”:<\/div>\n
curl -X POST JENKINS_URL\/job\/JOB_NAME\/build \\<\/div>\n
  –data token=TOKEN \\<\/div>\n
  –data-urlencode json='{“parameter”: [{“name”:”id”, “value”:”123″}, {“name”:”verbosity”, “value”:”high”}]}’<\/div>\n
<\/div>\n
Check Jenkins Job Status via REST API<\/strong><\/div>\n
<\/div>\n
job_status=`curl https:\/\/jenkins\/view\/job\/other-job\/lastBuild\/api\/json | grep “\\”result\\”:\\”SUCCESS\\””`<\/div>\n
if [ -n \"$job_status\" ] then     # Run your script commands here else   echo \"BUILD FAILURE: Other build is unsuccessful or status could not be obtained.\"   exit 1 fi<\/pre>\n
<\/div>\n
<\/div>\n
How to restart Jenkins manually?<\/strong><\/div>\n
<\/div>\n
To restart Jenkins manually, you can use either of the following commands:<\/div>\n
(jenkins_url)\/safeRestart – Allows all running jobs to complete. New jobs will remain in the queue to run after the restart is complete.<\/div>\n
<\/div>\n
(jenkins_url)\/restart – Forces a restart without waiting for builds to complete.<\/div>\n
<\/div>\n
Reference<\/strong><\/div>\n
https:\/\/wiki.jenkins-ci.org\/display\/JENKINS\/Remote+access+API<\/a><\/div>\n
<\/div>\n\n