GET /api/businesses/{BusinessID}/containers

Returns information about the API Gateway containers for a business.

Authorization Roles/Permissions: Must have Read permission for the resource. Must be a Business Admin or Site Admin.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/businesses/{BusinessID}/containers

Back to top

Sample Request

The example below shows a request for information about the valid containers for the specified business.

Request URL

https://{hostname}/api/businesses/tenantbusiness.acmepaymentscorp/containers

Sample request headers

GET /api/businesses/tenantbusiness.acmepaymentscorp/containers?_=1467317206509 HTTP/1.1
Accept: application/json, text/javascript, */*; q=0.01
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept

application/json, application/xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
BusinessID Path string Required The unique ID for a specific business organization on the platform.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about valid containers for the business.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/vnd.soa.v81+json

HTTP/1.1 200 OK
Date: Fri, 11 Nov 2016 17:10:12 GMT
Content-Type: application/vnd.soa.v81+json

Sample response body: application/vnd.soa.v81+json

{
  "Container" : [ {
    "Name" : "eapnd83",
    "ListenerName" : "default-http0",
    "ContainerKey" : "bM25-vuHR96BN7c-rVZnVw",
    "Location" : "http://acmepaymentscorp.com:7901"
  }, {
    "Name" : "eapnd2_83",
    "ListenerName" : "default-http0",
    "ContainerKey" : "nd2",
    "Location" : "http://acmepaymentscorp.com:7904"
  } ]
}

Back to top

Sample response headers: application/vnd.soa.v81+xml

HTTP/1.1 200 OK
Date: Thu, 30 Jun 2016 20:38:40 GMT
Content-Type: application/vnd.soa.v81+xml

Sample response body: application/vnd.soa.v81+xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Containers xmlns="http://soa.com/xsd/business/1.0" xmlns:ns2="http://soa.com/xsd/api/1.0" xmlns:ns3="http://soa.com/xsd/legals/1.0" xmlns:ns4="http://soa.com/xsd/dnmodel/1.0">
  <Container>
    <Name>eapnd</Name>
    <ListenerName>default-http0</ListenerName>
    <ContainerKey>_OiuCUt8TdqUdHdpxwne5g</ContainerKey>
    <Location>http://ubu1464qa-10.local.akana.com:7901</Location>
  </Container>
</Containers>

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type

application/json, application/xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Back to top

Response Body

Name Type Description
Containers Containers Contains information about one or more OSGi container on the platform.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics