Many objects of Jenkins provide the remote access API. They are available at /.../api/ where "..." portion is the object for which you'd like to access.
For more information about remote API in Jenkins, see the documentation.
Controlling the amount of data you fetch
In all formats, the depth query parameter can be used to control the amount of data you'll receive. The default is depth=0, but by increasing this value you can get a lot of data by single remote API invocation (the downside is bigger bandwidth requirement.) Compare depth=0 and depth=1 and see what the difference is for yourself. Also note that data created by a smaller depth value is always a subset of the data created by a bigger depth value.
A newer alternative is the tree query parameter. This works with any format, e.g. JSON; is more efficient than using depth with exclude (since information does not need to be generated on the server and then discarded); and may be easier to use, since you need only know what elements you are looking for, rather than what you are not looking for (which is anyway an open-ended list when plugins can contribute API elements). The value should be a list of property names to include, with subproperties inside square braces. Try tree=jobs[name],views[name,jobs[name]] to see just a list of jobs (only giving the name) and views (giving the name and jobs they contain). Note: for array-type properties (such as jobs in this example), the name must be given in the original plural, not in the singular as the element would appear in XML (<job>). This will be more natural for e.g. json?tree=jobs[name] anyway: the JSON writer does not do plural-to-singular mangling because arrays are represented explicitly.
To create a new job, post config.xml to this URL with query parameter name=JOBNAME. You'll get 200 status code if the creation is successful, or 4xx/5xx code if it fails. config.xml is the format Jenkins uses to store the project in the file system, so you can see examples of them in /builds.
To copy a job, send a POST request to this URL with three query parameters name=NEWJOBNAME&mode=copy&from=FROMJOBNAME
Build queue has its own separate API.
Overall load statistics of Jenkins has its own separate API.
Jenkins will enter into the "quiet down" mode by sending a request to this URL. You can cancel this mode by sending a request to this URL. On environments where Jenkins can restart itself (such as when Jenkins is installed as a Windows service), POSTing to this URL will start the restart sequence, or this URL to restart once no jobs are running. All these URLs need the admin privilege to the system.
|Page generated: May 17, 2013 10:18:24 PMJenkins ver. 1.506|