Bamboo REST API: Not returning XML responses

[steven_green]

Using Postman I'm trying to get Bamboo REST API calls to return in XML format, however the server replies with a 406 Not Acceptable response. Following the documentation here I'm sending an Accept header with the value "application/xml".

If I make the same call either omitting the header or specifying "application/json" I get the expected JSON response.

I couldn't find any API-related settings in the Bamboo admin menu, nor any documentation suggesting XML responses had been deprecated or removed.

What am I missing?

Example request headers:

GET /rest/api/latest/deploy/environment/207781962/results HTTP/1.1
Host: bamboo.wnet.local
Accept: application/xml
Authorization: Basic #############
User-Agent: PostmanRuntime/7.15.2
Cache-Control: no-cache
Postman-Token: 0dd05a32-15f4-4266-8282-490a8c8a56cb,98cdb200-3739-4bbf-a2bb-582c50ce4d29
Host: bamboo.wnet.local
Cookie: JSESSIONID=07BC7073BEE94B1828AEAD37BAD23A76
Accept-Encoding: gzip, deflate
Connection: keep-alive
cache-control: no-cache

Bamboo Server version: 6.8.1

[Rafael Pinto Sperafico · Accepted solution]

Hi @steven_green ,

I am afraid this REST API endpoint will only provide you a JSON response as its implementation only produces JSON and not XML:

@Path(RestConstants.DEPLOYMENT_ENDPOINT + "/" + RestConstants.ENVIRONMENT)
@Consumes({MediaType.APPLICATION_JSON})
@Produces({MediaType.APPLICATION_JSON})
@Singleton
public class DeploymentEnvironmentResource {
...

/**
 * Provide list of versions deployed to environment
 *
...
@GET
@Path("{environmentId}/results")
public RestDeploymentResultList getDeploymentResultList(

The same information is available on Bamboo's REST API documentation - https://docs.atlassian.com/atlassian-bamboo/REST/6.8.1/

Kind regards,
Rafael

[steven_green]

Ah yes, I must have skimmed past this part of the preamble: "If not otherwise indicated, all methods return both XML and JSON."

What threw me off was that if you expand the section highlighted in your screenshot the example response is in XML.

Thanks for your answer, I'll mark it as accepted.

Cheers,
Steve