User:Catlee/BuildAPI

REST Interface

List of request methods, urls, and parameters

PUT and DELETE can also be achieved by POSTing to the URL with a POST field "_method" set to PUT or DELETE.

PUT, POST, and DELETE methods will return a job id that can be queried with the 'job_status' method.

GET /builds/branches -> list of branches

GET /builds/{branch} -> list of recent builds, including completed, running and pending

GET /builds/{branch}/build/{buildid} -> information about a particular build

GET /builds/{branch}/request/{requestid} -> information about a particular build request

GET /builds/{branch}/rev/{revision} -> list of builds for this revision

GET /builds/{branch}/builders -> list of valid builder names

GET /builds/{branch}/builders/{buildername} -> list of recent builds, including completed, running, and pending for this builder name

GET /builds/job_status/{job_id}

PUT /builds/{branch}/request/{requestid} -> update this build

• priority (required, sets the build request's priority)

DELETE /builds/{branch}/build/{buildid} -> cancel this build

DELETE /builds/{branch}/request/{requestid} -> cancel this buildrequest

• onlyifrunning (optional, set to only cancel builds if they're running)
• onlyifpending (optional, set to only cancel builds if they're pending)

DELETE /builds/{branch}/rev/{revision} -> cancel pending/running builds for this revision

• onlyifrunning (optional, set to only cancel builds if they're running)
• onlyifpending (optional, set to only cancel builds if they're pending)
• killmerged (optional, set to cancel builds that are merged with other revisions)

POST /builds/{branch}/rev/{revision} -> create a new build with this revision

• buildername (required, which builder to create builds for, can be specified multiple times)
• properties (optional, extra properties for this build)

POST /builds/{branch}/builders/{buildername} -> create a new build on this builder

• revision (optional, which revision to build)
• properties (optional, extra properties for this build)

POST /builds/{branch}/build -> rebuilds an old build on this branch

• buildid (which build to rebuild)
• properties (optional, extra properties for this build)

POST /builds/{branch}/request -> rebuilds an old build on this branch

• requestid (which request to rebuild)
• properties (optional, extra properties for this build)

Object definitions

Builds:

• buildid
• buildrequests
• buildnumber
• buildername
• branch
• revision
• starttime
• endtime
• status

Build Requests:

• buildrequestid
• buildername
• branch
• revision
• submittime