Rate this page:
There are a number of characteristics that are common across the Bamboo REST APIs. These are described below.
You can authenticate yourself for the REST APIs in two ways:
Use personal access token as a Bearer
credential in an HTTP Authorisation
header. For more information, see Personal access tokens.
Example
1
curl -H "Authorization: Bearer NDc4NDkyNDg3ODE3OstHYSeYC1UgXqRacSqvUbookcZk" http://localhost:8085/rest/api/latest/plan/PROJ-PLAN.json
Basic username:password
at Authorisation
HTTP header. The URL must also contain the os_authType=basic
query parameter. Example:
1 2
wget --http-user=admin --http-password=admin http://localhost:8085/rest/api/latest/plan/PROJ-PLAN?os_authType=basic
curl --user admin:admin http://localhost:8085/rest/api/latest/plan/PROJ-PLAN?os_authType=basic
Or in a browser use:
1
http://host:8085/rest/api/latest/plan?os_authType=basic
URIs for a Bamboo REST API resource have the following structure:
1
http://host:port/bamboo/rest/api-name/api-version/resource-name
Example:
1
http://myhost.com:8085/bamboo/rest/api/latest/plan
The parts of the URI are:
host
and port
define the host and port where the Bamboo application lives.bamboo
signifies that the request is to be directed to the 'bamboo' application.rest
denotes the REST API.api-name
identifies a specific API. This will always be api
for a Bamboo REST API.api-version
is the API version number, e.g. latest
, 1
, 2
, etc. See the section on BAMBOO:API version control.resource-name
identifies the required resource. In some cases, this may be a generic resource name such as /foo
. In other cases, this may include a generic resource name and key. For example, /foo
returns a list of the foo
items and /foo/{key
} returns the full content of the foo
identified by the given key
.Refer to the details of the specific REST resources.
The Bamboo REST APIs return HTTP responses in one of the following formats:
Response Format | Requested via... |
---|---|
JSON | Requested via one of the following:
|
XML | Requested via one of the following:
|
Example:
To request an HTTP response on JSON format:
1
http://myhost.com:8085/bamboo/rest/api/latest/plan.json
The Bamboo REST APIs are version controlled. The version number of an API appears in its URI. For example, use this URI structure to request version 1 of the Bamboo REST API:
1
http://myhost.com:8085/bamboo/rest/api/1/
To get the latest version of the API, you can also use the latest
key-word. For example, if versions 1 and 2 of the 'admin' API are available, the following two URIs will point to the same resources:
1 2
http://myhost.com:8085/bamboo/rest/api/latest/...
http://myhost.com:8085/bamboo/rest/api/2/...
Notes:
1
or 2
.An error condition will return an HTTP error code as described in the Atlassian REST Guidelines.
You will use the standard HTTP methods to access Bamboo via the REST APIs. Please refer to the resource descriptions for further details.
Rate this page: