User:Catlee/BuildAPI: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
Line 8: Line 8:


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


GET /builds/{branch}/rev/{revision} -> list of builds for this revision
GET /builds/{branch}/rev/{revision} -> list of builds for this revision
Line 15: Line 17:
GET /builds/{branch}/builders/{buildername} -> list of recent builds, including completed, running, and pending for this builder name
GET /builds/{branch}/builders/{buildername} -> list of recent builds, including completed, running, and pending for this builder name


PUT /builds/{branch}/build/{buildid} -> update this build
PUT /builds/{branch}/buildrequest/{requestid} -> update this build
* priority (required, sets the build request's priority)
* priority (required, sets the build request's priority)


DELETE /builds/{branch}/build/{buildid} -> cancel this build
DELETE /builds/{branch}/build/{buildid} -> cancel this build
DELETE /builds/{branch}/buildrequest/{requestid} -> cancel this buildrequest
* onlyifrunning (optional, set to only cancel builds if they're running)
* onlyifrunning (optional, set to only cancel builds if they're running)
* onlyifpending (optional, set to only cancel builds if they're pending)
* onlyifpending (optional, set to only cancel builds if they're pending)
Line 26: Line 30:
* onlyifpending (optional, set to only cancel builds if they're pending)
* onlyifpending (optional, set to only cancel builds if they're pending)
* killmerged (optional, set to cancel builds that are merged with other revisions)
* killmerged (optional, set to cancel builds that are merged with other revisions)
POST /builds/{branch}/rev/{revision} -> create a new build with this revision  
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)
* buildername (required, which builder to create builds for, can be specified multiple times)
Line 33: Line 38:


POST /builds/{branch}/build -> rebuilds an old build on this branch  
POST /builds/{branch}/build -> rebuilds an old build on this branch  
* buildid (required, which build to rebuild)
* buildid (this or requestid required, which build to rebuild)
* requestid (which request to rebuild)


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

Revision as of 19:12, 30 September 2010

REST Interface

List of request methods, urls, and parameters:

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}/buildrequest/{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

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

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

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

DELETE /builds/{branch}/buildrequest/{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)

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

  • revision (optional, which revision to build)

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

  • buildid (this or requestid required, which build to rebuild)
  • requestid (which request to rebuild)

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