How to Retrieve Info Using Jenkins Remote Access API

We can use REST-like Remote Access API in Jenkins to post or retrieve information in XML or JSON format.  General format of the URL is <Jenkins-URL>/<data-context>/api/xml|json.
Below are few examples:

1) Retrieve Build Result.
Below examples shows the build result in JSON format for job 'web-apps-build-pkgvalidator' and build number ''6'. Credential is passed using '--user <user-name>:<password>'
result is piped to 'jq' to pretty print.
Notes:

•  'jq' is jQuery library. For more info visit https://jquery.com
• Instead of using password in your Jenkins API call, you can use API token. https://stackoverflow.com/questions/45466090/how-to-get-the-api-token-for-jenkins provides some quick instruction for generating Jenkins API token associated with your user. 

$> curl -X GET http://localhost:9090/job/web-apps-build-pkgvalidator/6/api/json --user ppoudel:<password> | jq   % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current                                  Dload  Upload   Total   Spent    Left  Speed   100  1765  100  1765    0     0  14120   0 --:--:-- --:--:-- --:--:-- 16192 {   "_class": "hudson.maven.MavenModuleSetBuild",   "actions": [     {},     {       "_class": "hudson.model.CauseAction",       "causes": [         {           "_class": "hudson.model.Cause$UserIdCause",           "shortDescription": "Started by user Purna Poudel",           "userId": "ppoudel",           "userName": "Purna Poudel"         }       ]     },     {       "_class": "hudson.plugins.git.util.BuildData",       "buildsByBranchName": {         "refs/remotes/origin/release/release-2.0.3": {           "_class": "hudson.plugins.git.util.Build",           "buildNumber": 6,           "buildResult": null,           "marked": {             "SHA1": "2c60eff4fef13e9346ae7c6b848efdc2fbf31026",             "branch": [               {                 "SHA1": "2c60eff4fef13e9346ae7c6b848efdc2fbf31026",                 "name": "refs/remotes/origin/release/release-2.0.3"               }             ]           },           "revision": {             "SHA1": "2c60eff4fef13e9346ae7c6b848efdc2fbf31026",             "branch": [               {                 "SHA1": "2c60eff4fef13e9346ae7c6b848efdc2fbf31026",                 "name": "refs/remotes/origin/release/release-2.0.3"               }             ]           }         }       },       "lastBuiltRevision": {         "SHA1": "2c60eff4fef13e9346ae7c6b848efdc2fbf31026",         "branch": [           {             "SHA1": "2c60eff4fef13e9346ae7c6b848efdc2fbf31026",             "name": "refs/remotes/origin/release/release-2.0.3"           }         ]       },       "remoteUrls": [         "https://pppoudel@bitbucket.org/pppoudel/pkgvalidator.git"       ],       "scmName": ""     },     {       "_class": "hudson.plugins.git.GitTagAction"     },     {},     {       "_class": "hudson.maven.reporters.MavenAggregatedArtifactRecord"     },     {},     {},     {}   ],   "artifacts": [],   "building": false,   "description": null,   "displayName": "#6",   "duration": 37633,   "estimatedDuration": 39130,   "executor": null,   "fullDisplayName": "web-apps-build-pkgvalidator #6",   "id": "6",   "keepLog": false,   "number": 6,   "queueId": 150,   "result": "SUCCESS",   "timestamp": 1546274196419,   "url": "http://localhost:8080/job/web-apps-build-pkgvalidator/6/",   "builtOn": "",   "changeSet": {     "_class": "hudson.plugins.git.GitChangeSetList",     "items": [],     "kind": "git"   },   "culprits": [     {       "absoluteUrl": "http://localhost:8080/user/ppoudel",       "fullName": "Purna Poudel"     }   ],   "mavenArtifacts": {},   "mavenVersionUsed": "3.5.4" }

2) Below example shows use of /api/xml with 'xpath' to get just the build status from the build report.

$> curl -X GET http://localhost:9090/job/web-apps-build-pkgvalidator/6/api/xml?xpath=/*/result --user ppoudel:<password> % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 24 0 24 0 0 102 0 --:--:-- --:--:-- --:--:-- 110 <result>SUCCESS</result>

3) Getting build status using /api/json. The following example shows retrieving job name, build number, build status and timestamp.

$> curl -X GET http://localhost:9090/job/web-apps-build-pkgvalidator/6/api/json?tree=fullDisplayName,number,result,timestamp --user ppoudel:<password>   % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current                                  Dload  Upload   Total   Spent    Left  Speed 100   152  100   152    0     0   1216      0 --:--:-- --:--:-- --:--:--  1394 {"_class":"hudson.maven.MavenModuleSetBuild","fullDisplayName":"web-apps-build-pkgvalidator #6","number":6,"result":"SUCCESS","timestamp":1546274196419}

4) Retrieving all jobs under certain view:
Note: here I'm piping the result through 'jq' and 'grep', which is optional.

curl -X GET http://localhost:9090/job/Web/job/mobile-apps/view/mobile-apps/api/json --user ppoudel:<password> | jq | grep name "name": "mobile-apps-xyzmportal", "name": "mobile-apps-holportal", "name": "mobile-apps-tpl", ... ... "name": "mobile-apps-bcs_jpj",

 5) Retrieving JUnit test summary report:

$> curl http://localhost:9090/job/web-apps-build-pkgvalidator/6/testReport/api/json?tree=failCount,skipCount,totalCount,urlName --user ppoudel:<password> % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current                                  Dload  Upload   Total   Spent    Left  Speed 100   127  100   127    0     0    451      0 --:--:-- --:--:-- - 579 {"_class":"hudson.maven.reporters.SurefireAggregatedReport","failCount":0,"skipCount":0,"totalCount":20,"urlName":"testReport

6) Below steps can be used to retrieve the SonarQube analysis result using Jenkins' remote REST like API.
6.1) Get the taskId from the build providing build number
Note: http://localhost:9090 is Jenkins server URL.

curl -X GET http://localhost:9090/job/web-apps-build-pkgvalidator_sonarqube/6/api/json --user ppoudel:<password> | jq | grep ceTaskId   % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current                                  Dload  Upload   Total   Spent    Left  Speed 100  5182  100  5182    0     0  18507      0 --:--:-- --:--:-- --:--:-- 20811       "ceTaskId": "AWfXjftAinfFqLzOhqqe",

6.2)  Get the analysisId using taskID:
Note: http://localhost:8000 is SonarQube URL.

$> curl -X GET http://localhost:8000/api/ce/task?id=AWfXjftAinfFqLzOhqqe --user ppoudel:<password> | jq | grep analysisId   % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current                                  Dload  Upload   Total   Spent    Left  Speed 100   518  100   518    0     0   2770      0 --:--:-- --:--:-- --:--:--  3029     "analysisId": "AWfXjgNNVNzkngEjXoPD",

6.3) Get the analysis report using analysisId:

$> curl -X GET http://localhost:8000/api/qualitygates/project_status?analysisId=AWfXjgNNVNzkngEjXoPD --user ppoudel:<password> | jq   % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current                                  Dload  Upload   Total   Spent    Left  Speed 100  1438  100  1438    0     0   4608      0 --:--:-- --:--:-- --:--:--  4841 {   "projectStatus": {     "status": "ERROR",     "conditions": [       {         "status": "OK",         "metricKey": "new_maintainability_rating",         "comparator": "GT",         "periodIndex": 1,         "warningThreshold": "1",         "actualValue": "1"       },       {         "status": "OK",         "metricKey": "new_reliability_rating",         "comparator": "GT",         "periodIndex": 1,         "warningThreshold": "1",         "actualValue": "1"       },       {         "status": "OK",         "metricKey": "new_security_rating",         "comparator": "GT",         "periodIndex": 1,         "errorThreshold": "1",         "actualValue": "1"       },       {         "status": "OK",         "metricKey": "sqale_rating",         "comparator": "GT",         "warningThreshold": "3",         "actualValue": "1"       },       {         "status": "ERROR",         "metricKey": "security_rating",         "comparator": "GT",         "errorThreshold": "1",         "actualValue": "5"       },       {         "status": "WARN",         "metricKey": "reliability_rating",         "comparator": "GT",         "warningThreshold": "3",         "actualValue": "5"       },       {         "status": "ERROR",         "metricKey": "blocker_violations",         "comparator": "GT",         "errorThreshold": "0",         "actualValue": "180"       },       {         "status": "WARN",         "metricKey": "critical_violations",         "comparator": "GT",         "warningThreshold": "0",         "actualValue": "3806"       },       {         "status": "WARN",         "metricKey": "major_violations",         "comparator": "GT",         "warningThreshold": "0",         "actualValue": "2878"       },       {         "status": "WARN",         "metricKey": "coverage",         "comparator": "LT",         "warningThreshold": "80",         "actualValue": "0.1"       },       {         "status": "ERROR",         "metricKey": "vulnerabilities",         "comparator": "GT",         "errorThreshold": "0",         "actualValue": "107"       }     ],     "periods": [       {         "index": 1,         "mode": "previous_version",         "date": "2018-12-15T15:11:09-0500",         "parameter": "1.5.8-SNAPSHOT"       }     ],     "ignoredConditions": false   } }

7) If you need to get all the configured projects (paginated output) in SonarQube you can use the following URL:
Note: http://localhost:8000 is SonarQube URL.

# First page: $> curl -X GET http://localhost:8000/api/components/search?qualifiers=TRK&p=1

8) Or get detail of a specific project:
Note: http://localhost:8000 is SonarQube URL.

$> http://localhost:8000/api/components/show?key=<project-key&gt

For more information on Remote access API visit https://wiki.jenkins.io/display/JENKINS/Remote+access+API

You may be interested reading the following Jenkins related blog:
Jenkins Job Chain and How to Resolve Issue with Parameter Passing
Jenkins Pipeline - Few Troubleshooting Tips