GET /api/apis/versions/{APIVersionID}/implementations/{ImplCode}/deploymentsuggestions

Returns information about suggested deployment zones for an API version based on the API definition and deployment zone definitions.

New in API Platform Version: 8.1

Authorization Roles/Permissions: Must have Read permission for the resource.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apis/versions/{APIVersionID}/implementations/{ImplCode}/deploymentsuggestions

Back to top

Sample Request

The example below shows a request for information about eligible deployment zones for the specified API version.

Request URL

https://{hostname}/api/apis/versions/8fff41fb-1dcf-4843-95d2-d96b5d41c956.acmepaymentscorp/implementations/live/deploymentsuggestions

Sample request headers

GET /api/apis/versions/8fff41fb-1dcf-4843-95d2-d96b5d41c956.acmepaymentscorp/implementations/live/deploymentsuggestions HTTP/1.1
Host: {hostname}
Accept: application/vnd.soa.v81+json
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
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
APIVersionID Path String Required The unique ID for a specific API version.
ImplCode Path string Required A code for a specific implementation. Valid values: Live or Sandbox.
DeploymentZoneID Query string Optional Unique ID for a specific deployment zone.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the deployment zones that match up with the API definition.

Back to top

Sample Response

The sample response below shows successful completion of this operation. In this example, there are three deployment zone endpoints (listeners) set up for the deployment zone.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/vnd.soa.v81+json
Date: Thu, 27 Apr 2017 14:56:32 GMT

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

{
  "DeploymentZonesHostingInfo" : [ {
    "DeploymentZoneID" : "9561a62d-cf13-47de-b746-a1306796cc00.automation",
    "DeploymentZoneEndpoint" : [ {
      "DeploymentZoneID" : "9561a62d-cf13-47de-b746-a1306796cc00.automation",
      "ListenerName" : "default-http0",
      "ContainerKey" : "fae3-b808-4fc6-85aa-88518e2a81d7",
      "GatewayHostName" : "api10063live.ubu1464qa-10.local.akana.com",
      "GatewayHostPath" : "",
      "EndpointHostName" : "api10063live.ubu1464qa-10.local.akana.com",
      "EndpointPath" : "/",
      "Protocol" : "http",
      "Path" : "",
      "Url" : "http://api10063live.ubu1464qa-10.local.akana.com:7905"
    }, {
      "DeploymentZoneID" : "9561a62d-cf13-47de-b746-a1306796cc00.automation",
      "ListenerName" : "https",
      "ContainerKey" : "fae3-b808-4fc6-85aa-88518e2a81d7",
      "GatewayHostName" : "api10063live.ubu1464qa-10.local.akana.com",
      "GatewayHostPath" : "",
      "EndpointHostName" : "api10063live.ubu1464qa-10.local.akana.com",
      "EndpointPath" : "/",
      "Protocol" : "https",
      "Path" : "",
      "Url" : "https://api10063live.ubu1464qa-10.local.akana.com:7908"
    }, {
      "DeploymentZoneID" : "9561a62d-cf13-47de-b746-a1306796cc00.automation",
      "ListenerName" : "http2",
      "ContainerKey" : "fae3-b808-4fc6-85aa-88518e2a81d7",
      "GatewayHostName" : "api10063live.ubu1464qa-10.local.akana.com",
      "GatewayHostPath" : "",
      "EndpointHostName" : "api10063live.ubu1464qa-10.local.akana.com",
      "EndpointPath" : "/",
      "Protocol" : "http",
      "Path" : "",
      "Url" : "http://api10063live.ubu1464qa-10.local.akana.com:7906"
    } ]
  } ]
}

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

Status Code: 200 OK
Content-Type: application/vnd.soa.v81+xml
Date: Thu, 27 Apr 2017 14:59:51 GMT

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns7:APIImplementationDeployments xmlns:ns2="http://soa.com/xsd/resource/1.0" xmlns:ns3="http://soa.com/xsd/business/1.0" 
xmlns:ns4="http://soa.com/xsd/deploymentzone/1.0" xmlns:ns5="http://soa.com/xsd/asset/1.0" xmlns:ns6="http://soa.com/xsd/dnmodel/1.0" 
xmlns:ns7="http://soa.com/xsd/api/1.0" xmlns:ns8="http://soa.com/xsd/legals/1.0">
  <ns7:DeploymentZonesHostingInfo>
    <ns4:DeploymentZoneID>9561a62d-cf13-47de-b746-a1306796cc00.acmepaymentscorp</ns4:DeploymentZoneID>
    <ns7:DeploymentZoneEndpoint>
      <ns4:DeploymentZoneID>9561a62d-cf13-47de-b746-a1306796cc00.acmepaymentscorp</ns4:DeploymentZoneID>
      <ns7:ListenerName>default-http0</ns7:ListenerName>
      <ns7:ContainerKey>fae3-b808-4fc6-85aa-88518e2a81d7</ns7:ContainerKey>
      <ns7:GatewayHostName>api10063live.ubu1464qa-10.local.akana.com</ns7:GatewayHostName>
      <ns7:GatewayHostPath></ns7:GatewayHostPath>
      <ns7:EndpointHostName>api10063live.ubu1464qa-10.local.akana.com</ns7:EndpointHostName>
      <ns7:EndpointPath>/</ns7:EndpointPath>
      <ns7:Protocol>http</ns7:Protocol>
      <ns7:Path></ns7:Path>
      <ns7:Url>http://api10063live.ubu1464qa-10.local.akana.com:7905</ns7:Url>
    </ns7:DeploymentZoneEndpoint>
    <ns7:DeploymentZoneEndpoint>
      <ns4:DeploymentZoneID>9561a62d-cf13-47de-b746-a1306796cc00.acmepaymentscorp</ns4:DeploymentZoneID>
      <ns7:ListenerName>https</ns7:ListenerName>
      <ns7:ContainerKey>fae3-b808-4fc6-85aa-88518e2a81d7</ns7:ContainerKey>
      <ns7:GatewayHostName>api10063live.ubu1464qa-10.local.akana.com</ns7:GatewayHostName>
      <ns7:GatewayHostPath></ns7:GatewayHostPath>
      <ns7:EndpointHostName>api10063live.ubu1464qa-10.local.akana.com</ns7:EndpointHostName>
      <ns7:EndpointPath>/</ns7:EndpointPath>
      <ns7:Protocol>https</ns7:Protocol>
      <ns7:Path></ns7:Path>
      <ns7:Url>https://api10063live.ubu1464qa-10.local.akana.com:7908</ns7:Url>
    </ns7:DeploymentZoneEndpoint>
    <ns7:DeploymentZoneEndpoint>
      <ns4:DeploymentZoneID>9561a62d-cf13-47de-b746-a1306796cc00.acmepaymentscorp</ns4:DeploymentZoneID>
      <ns7:ListenerName>http2</ns7:ListenerName>
      <ns7:ContainerKey>fae3-b808-4fc6-85aa-88518e2a81d7</ns7:ContainerKey>
      <ns7:GatewayHostName>api10063live.ubu1464qa-10.local.akana.com</ns7:GatewayHostName>
      <ns7:GatewayHostPath></ns7:GatewayHostPath>
      <ns7:EndpointHostName>api10063live.ubu1464qa-10.local.akana.com</ns7:EndpointHostName>
      <ns7:EndpointPath>/</ns7:EndpointPath>
      <ns7:Protocol>http</ns7:Protocol>
      <ns7:Path></ns7:Path>
      <ns7:Url>http://api10063live.ubu1464qa-10.local.akana.com:7906</ns7:Url>
    </ns7:DeploymentZoneEndpoint>
  </ns7:DeploymentZonesHostingInfo>
</ns7:APIImplementationDeployments>

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
APIImplementationDeployments APIImplementationDeployments Contains information about the deployment zones associated with a specific API version implementation, or that a specific API version implementation is eligible for based on the API version definition and deployment zone definitions.

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