GET /api/deploymentzones

Returns a list of valid deployment zones on the platform, in the form of a JSON or XML object.

Note: Be sure to include a valid Accept header with this operation. If you don't include the Accept header, the operation might fail.

Authorization Roles/Permissions: Must be logged in. Must have Read permission for the resource. For example, a Business Admin or an API Admin.

This topic includes the following sections:

HTTP Method
URL
Sample Request
Request Headers
Request Parameters

Response
Sample Response
Response Headers
Response Body
Error Codes/Messages

HTTP Method

GET

URL

https://{hostname}/api/deploymentzones[?][Implementation={implementation}][&][{Environment={environment}]
[&][APIImplementationPattern={implementationpattern}][&][DzoneID={dzone1}][&][DzoneID={dzone2}]

In the context of a specific business:

https://{hostname}/api/deploymentzones?ContextID={BusinessID}[&][Implementation={implementation}][&][{Environment={environment}]
[&][APIImplementationPattern={implementationpattern}][&][DzoneID={dzone1}][&][DzoneID={dzone2}][&][ContextID={ContextID}]

Sample Request

The examples below show a request for the deployment zone information.

Request URL #1

https://{hostname}/api/deploymentzones

Request URL #2

https://{hostname}/api/deploymentzones?ContextID=87da343c-e260-43e2-8fbf-2fab7fae9203.acmepaymentscorp

Request URL #3

In the example below, the OrgKey parameter is included. This supersedes the ContextID.

https://{hostname}/api/deploymentzones?OrgKey=uddi%3Asoa.com%3Aatmosphere%3Abusiness%3A89535988-cfe8-44e0-8fdb-15f8ebf2109f

Sample request headers

GET /api/deploymentzones HTTP/1.1
Host: {hostname}
Accept: application/vnd.soa.v84+json

Sample request body

Not applicable.

Request Headers

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

Header	Description
Accept	application/vnd.soa.v81+json, application/vnd.soa.v81+xml, application/vnd.soa.v84+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
Implementation	Query	string	Optional	A specific implementation for which deployment zone information should be returned.
Environment	Query	string	Optional	A specific environment for which deployment zone information should be returned.
APIImplementationPattern	Query	string	Optional	A specific implementation pattern for which deployment zone information should be returned.
DzoneID	Query	string	Optional	One or more deployment zone IDs for which the information should be returned. For multiple deployment zones, list each one as a separate query parameter. Used by the UI to show deployment zones on the map.
ContextID Version: 2019.1.6	Query	string	Optional	In this scenario, the ContextID is the BusinessID of a sub-organization. If you're creating an API within the context of a specific organization level, it's important to include the optional ContextID in the request. This allows the Community Manager developer portal to determine that the user has the correct permissions to create an API for that organization. Notes: If ContextID is provided, the deployment zone permissions are checked against the context. If ContextID is not provided, the deployment zones for the top-level organization (tenant organization) are returned. If the OrgKey parameter is provided, OrgKey supersedes ContextID with regard to deployment zone permissions.
OrgKey Version: 2019.1.7	Query	string	Optional	If OrgKey is provided, the deployment zone permissions are checked against this context. If OrgKey is not provided, the deployment zones for the top-level organization (tenant organization) are returned. Note: If you're not sure of the OrgKey, you could run one of these operations to get the value: GET /api/apis/{APIID} operation (OrganizationKey value in the API response) GET /api/businesses/{BusinessID} operation (BusinessKey value in the API response).

Response

If successful, this operation returns HTTP status code 200, with the requested information about deployment zones.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Content-Type: application/vnd.soa.v84+json
Date: Thu, 23 Jan 2020 23:43:40 GMT

Sample response body #1

The sample response below is NOT in the context of a sub-organization, so the deployment zone information for the top-level organization (tenant organization) is returned.

{
  "DeploymentZoneInfo": [
    {
      "DeploymentZoneID": "container-1051.acmepaymentscorp",
      "Name": "Akana US West",
      "Description": "",
      "Location": "37.339835, -121.88615",
      "ContainerKey": "container-1051",
      "ContainerName": "Akana US West",
      "AddressOverrideBehavior": "com.akana.dontallow",
      "RandomHostNameBehavior": "com.akana.allow",
      "VirtualHostSupported": false,
      "DeploymentZoneAccessPoint": [
        {
          "Protocol": "http",
          "Name": "default-http0",
          "Address": "http://gateway.akana.com:80"
        },
        {
          "Protocol": "https",
          "Name": "default-https",
          "Address": "https://gateway.akana.com:443"
        },
        {
          "Protocol": "https",
          "Name": "mutual-https",
          "Address": "https://mtl-west.gateway.akana.com:443"
        }
      ],
      "DZoneEnvImplAssociations": {
        "DZoneEnvImplAssociation": [
          {
            "Implementation": "Live",
            "Environment": "Production"
          },
          {
            "Implementation": "Sandbox",
            "Environment": "Production"
          }
        ]
      }
    }
  ]
}

Sample response body #2

In the example below, the request was in the context of a sub-organization (ContextID parameter included in the request).

{
  "DeploymentZoneInfo": [
    {
      "DeploymentZoneID": "container-1051.acmepaymentscorp",
      "Name": "Akana US West",
      "Description": "",
      "Location": "37.339835, -121.88615",
      "ContainerKey": "container-1051",
      "ContainerName": "Akana US West",
      "AddressOverrideBehavior": "com.akana.dontallow",
      "RandomHostNameBehavior": "com.akana.allow",
      "VirtualHostSupported": false,
      "DeploymentZoneAccessPoint": [
        {
          "Protocol": "http",
          "Name": "default-http0",
          "Address": "http://gateway.akana.com:80"
        },
        {
          "Protocol": "https",
          "Name": "default-https",
          "Address": "https://gateway.akana.com:443"
        },
        {
          "Protocol": "https",
          "Name": "mutual-https",
          "Address": "https://mtl-west.gateway.akana.com:443"
        }
      ],
      "DZoneEnvImplAssociations": {
        "DZoneEnvImplAssociation": [
          {
            "Implementation": "Live",
            "Environment": "Production"
          },
          {
            "Implementation": "Sandbox",
            "Environment": "Production"
          }
        ]
      }
    }
  ]
}

Sample response body #3

In the example below, the request was in the context of a sub-organization (OrgKey parameter included in the request).


{
  "DeploymentZoneInfo": [
    {
      "DeploymentZoneID": "c377f0a2-70f5-4e32-aa8e-cf957b385595.acmepaymentscorp",
      "Name": "bhJNQX",
      "Description": "ppbABT",
      "ContainerKey": "1652-80ac-4379-aeb3-d391dca8533e",
      "ContainerName": "eapNd",
      "AddressOverrideBehavior": "com.akana.allow",
      "RandomHostNameBehavior": "com.akana.dontallow",
      "HostName": "testing.acmepaymentscorp.com",
      "VirtualHostSupported": true,
      "DeploymentZoneAccessPoint": [
        {
          "Protocol": "http",
          "Name": "default-http0",
          "Address": "http://testing.acmepaymentscorp.com:7905"
        }
      ],
      "DZoneEnvImplAssociations": {
        "DZoneEnvImplAssociation": [
          {
            "Implementation": "Live",
            "Environment": "Production"
          },
          {
            "Implementation": "Sandbox",
            "Environment": "Production"
          }
        ]
      }
    }
  ]
}

Response Headers

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

Header	Description
Content-Type	application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Response Body

Name	Type	Description
DeploymentZoneInfoList	DeploymentZoneInfoList	Contains information about deployment zones for a specific tenant, in the form of a list.

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.