REST API

Access data exposed in HTML as XML for machine consumption.
Schema is also available.

You can also specify optional XPath to control the fragment you'd like to obtain (but see below).
For example, ../api/xml?xpath=/*/*[0].

For XPath that matches multiple nodes, you need to also specify the "wrapper" query parameter
to specify the name of the root XML element to be create so that the resulting XML becomes well-formed.

Similarly exclude query parameter can be used to exclude nodes
that match the given XPath from the result. This is useful for
trimming down the amount of data you fetch (but again see below). This query parameter can be specified
multiple times.

XPath filtering is powerful, and you can have it only return a very small data, but note that
the server still has to build a full DOM of the raw data, which could cause a large memory spike.
To avoid overloading the server, consider using the tree parameter, or use the xpath parameter
in conjunction with the tree parameter. When used together, the result of the tree parameter
filtering is built into DOM, then the XPath is applied to compute the final return value. In this way,
you can often substantially reduce the size of DOM built in memory.

Access the same data as Python for Python clients. This can be parsed into Python
object as eval(urllib.urlopen("...").read()) and the resulting object
tree is identical to that of JSON.
However, when you do this, beware of the security implication. If you are connecting
to a non-trusted Jenkins, the server can send you malicious Python programs.

In Python 2.6 or later you can safely parse this output using
ast.literal_eval(urllib.urlopen("...").read())

Controlling the amount of data you fetch

The tree query parameter allows you to explicitly specify and retrieve only
the information you are looking for, by using an XPath-ish path expression.
The value should be a list of property names to include, with sub-properties 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.

For array-type properties, a range specifier is supported. For example, tree=jobs[name]{0,10} would
retrieve the name of the first 10 jobs. The range specifier has the following variants:

{M,N}: From the M-th element (inclusive) to the N-th element (exclusive).

{M,}: From the M-th element (inclusive) to the end.

{,N}: From the first element (inclusive) to the N-th element (exclusive). The same as {0,N}.

{N}: Just retrieve the N-th element. The same as {N,N+1}.

Another way to retrieve more data is to use the depth=N query parameter .
This retrieves all the data up to the specified depth.
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.

Because of the size of the data, the depth parameter should really be only used to explore
what data Jenkins can return. Once you identify the data you want to retrieve, you can then come up with
the tree parameter to exactly specify the data you need.