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

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

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

This topic includes the following sections:

HTTP Method

GET

URL

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

Sample Request

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

Sample 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_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

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
Cookie AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

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.

Response

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

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: Wed, 11 Nov 2020 20:35:45 GMT

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

{
  "DeploymentZonesHostingInfo":[
    {
      "DeploymentZoneID":"1c64704a-03cd-46c4-ba07-3786f8f82a8c.acmepaymentscorp",
      "DeploymentZoneEndpoint":[
        {
          "DeploymentZoneID":"1c64704a-03cd-46c4-ba07-3786f8f82a8c.acmepaymentscorp",
          "ListenerName":"default-http0",
          "ContainerKey":"9d5d-ffd4-4e6a-9334-bd850387eed9",
          "GatewayHostName":"10.250.24.9",
          "GatewayHostPath":"",
          "EndpointHostName":"10.250.24.9",
          "EndpointPath":"/api17135live",
          "Protocol":"http",
          "Path":"/api17135live",
          "Url":"http://10.250.24.9:7905/api17135live"
        },
        {
          "DeploymentZoneID":"1c64704a-03cd-46c4-ba07-3786f8f82a8c.acmepaymentscorp",
          "ListenerName":"default-https",
          "ContainerKey":"9d5d-ffd4-4e6a-9334-bd850387eed9",
          "GatewayHostName":"akana-qa-2.aws.akana.roguewave.com",
          "GatewayHostPath":"",
          "EndpointHostName":"akana-qa-2.aws.akana.roguewave.com",
          "EndpointPath":"/api17135live",
          "Protocol":"https",
          "Path":"/api17135live",
          "Url":"https://akana-qa-2.aws.akana.roguewave.com:9443/api17135live"
        }
      ]
    },
    {
      "DeploymentZoneID":"62bcbae7-e212-43cf-93b2-b03935eca52e.acmepaymentscorp",
      "DeploymentZoneEndpoint":[
        {
          "DeploymentZoneID":"62bcbae7-e212-43cf-93b2-b03935eca52e.acmepaymentscorp",
          "ListenerName":"default-http0",
          "ContainerKey":"9d5d-ffd4-4e6a-9334-bd850387eed9",
          "GatewayHostName":"acmepaymentscorp.akana.roguewave.com",
          "GatewayHostPath":"",
          "EndpointHostName":"acmepaymentscorp.akana.roguewave.com",
          "EndpointPath":"/api17135live",
          "Protocol":"http",
          "Path":"",
          "Url":"http://acmepaymentscorp.akana.roguewave.com:7905"
        },
        {
          "DeploymentZoneID":"62bcbae7-e212-43cf-93b2-b03935eca52e.acmepaymentscorp",
          "ListenerName":"default-https",
          "ContainerKey":"9d5d-ffd4-4e6a-9334-bd850387eed9",
          "GatewayHostName":"acmepaymentscorp.akana.roguewave.com",
          "GatewayHostPath":"",
          "EndpointHostName":"acmepaymentscorp.akana.roguewave.com",
          "EndpointPath":"/api17135live",
          "Protocol":"https",
          "Path":"",
          "Url":"https://acmepaymentscorp.akana.roguewave.com:9443"
        }
      ]
    }
  ]
}

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

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.

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. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.