How can I get system configuration for jenkins using remote access API

Question

Jenkins provide nice Remote Access API, which can be used to fetch lots of information like jobs and views.

I wonder whether or how to fetch the system (global) configurations from remote access API.

Those information are in web page http://your.jenkins.url/manage

similar question http://stackoverflow.com/questions/7064119/expose-hudson-system-info-to-remote-api — Larry Cai, Aug 22 '13 at 01:54

coffeebreaks · Accepted Answer · 2015-10-05T07:38:38.250

18

You can GET the config of your master / nodes through

http://your.jenkins.url/computer/(master)/config.xml

Is that good enough for you ?

Note: since mid-2014, POSTing has been disabled.

To find more about APIs, try adding /api to the end of some URLs.

To find which objects expose APIs, search for _api.jelly in https://github.com/jenkinsci/jenkins/find/master (press 't' then type '_api.jelly')

edited Oct 05 '15 at 07:38

answered Aug 21 '13 at 05:21

coffeebreaks

3,787
1
26
25

1

Yes, it is amazing! How can you know this ? ;-), can you list where you get this information ? – Larry Cai Aug 21 '13 at 07:07
@LarryCai Found the information browsing http://your.jenkins.url/computer/(master)/api . Added more information to the answer on how to find more API info. – coffeebreaks Aug 21 '13 at 14:53
awesome, now I know almost all the API – Larry Cai Aug 22 '13 at 01:38
This doesn't work anymore. Looks like POSTing to config.xml has been disabled on purpose. https://github.com/jenkinsci/jenkins/pull/1258 – Hannes Oct 05 '15 at 03:03
1

You're right. POSTing hasn't worked in a while. GETing still works though. I'll update it. – coffeebreaks Oct 05 '15 at 07:36
Thanks for this :) – Pierre Mar 15 '16 at 14:34
Will this show `Global properties` (e.g. from `/jenkins/configure`)? – Nick Grealy May 08 '17 at 07:39
Requested a standard way to list all api objects at https://issues.jenkins-ci.org/browse/JENKINS-54211 - also see https://stackoverflow.com/questions/49074011/how-to-get-a-list-of-all-available-jenkin-apis?noredirect=1&lq=1 – Ben Creasy Oct 23 '18 at 18:59

score 3 · Answer 2 · answered Sep 05 '14 at 17:36

For specifically system configuration information, such as all fo the environment variables and such, not what your description was asking for but the title, you'll want to append /systemInfo to the end of your URL.

http:<YourURLHere>/systemInfo

Then you'll have to pass some authentication to it and then you should be presented with an HTML listing of the information. So you'd have to do some parsing, as if you use grep, it'll just return the entire table.

http://fakeurl.com/systemInfo --user 'fakeuser':'fakepasswd'

score 0 · Answer 3 · answered Mar 31 '17 at 06:38

In my plugin i have accessed the system configuartion,"Artifactory credentials". 1) add the artifactory dependency in pom.xml. i.e.

<dependency>
            <groupId>org.jenkins-ci.plugins</groupId>
            <artifactId>artifactory</artifactId>
            <version>2.9.0</version>
            <type>jar</type>
        </dependency>

2) find the exact maching global.jelly config. i found in org.jfrog.hudson.ArtifactoryBuilder

                            <table style="width: 100%" id="legacyDeployerCredentials${server.url}">
                                <f:entry title="Username"
                                         help="/plugin/artifactory/help/common/help-deployerUserName.html">
                                    <f:textbox name="username" field="username"
                                               value="${server.deployerCredentialsConfig.username}"/>
                                </f:entry>
                                <f:entry title="Password"
                                         help="/plugin/artifactory/help/common/help-deployerPassword.html">
                                    <f:password name="password" field="password"
                                                value="${server.deployerCredentialsConfig.password}"/>
                                </f:entry>
                            </table>
                        </f:block>
                    </f:section>

3) identify the class used for applying the configuration. org.jfrog.hudson.ArtifactoryBuilder.java 4) create jenkins instance and access the plugin descriptor get user credential.

ArtifactoryBuilder.DescriptorImpl ab = (ArtifactoryBuilder.DescriptorImpl) jenkins.model.Jenkins.getInstance().getDescriptor(ArtifactoryBuilder.class);
        ArtifactoryServer server = ab.getArtifactoryServers().iterator().next();
        this.userName =  server.getDeployerCredentialsConfig().getUsername();
        this.password =  server.getDeployerCredentialsConfig().getPassword();

How can I get system configuration for jenkins using remote access API

3 Answers3

Linked