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.

New in API Platform Version: 8.1

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

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

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

Back to top

Sample Request

The example below shows a request for the deployment zone information.

Request URL

https://{hostname}/api/deploymentzones

Sample request headers

GET /api/deploymentzones 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/vnd.soa.v81+json, application/vnd.soa.v81+xml

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

Back to top

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.
ApiID Query string Optional The API ID. If this parameter is included, only deployment zones available to the specified API are returned.

Back to top

Response

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

Back to top

Sample Response

The sample response below shows successful completion of this operation.

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

Status Code: 200 OK
Content-Type: application/vnd.soa.v81+json
Date: Thu, 21 Jul 2016 18:27:33 GMT

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


{
  "DeploymentZoneInfo" : [ {
    "DZoneEnvImplAssociations" : {
      "DZoneEnvImplAssociation" : [ {
        "Implementation" : "Live",
        "Environment" : "Production"
      }, {
        "Implementation" : "Sandbox",
        "Environment" : "Production"
      } ]
    },
    "DeploymentZoneID" : "nkCl-3ScTUG1Zsvzim-BzA.atmosphere",
    "Name" : "eapnd",
    "Description" : "Built by Automation 07/21/16 (Please don\"t change or delete) \nPlatform Version ['8.2.0'] with: ND version ['8.2.0']",
    "Location" : "25.761680, -80.191790",
    "ContainerKey" : "nkCl-3ScTUG1Zsvzim-BzA",
    "ContainerName" : "eapnd",
    "AddressOverrideBehavior" : "com.akana.allow",
    "RandomHostNameBehavior" : "com.akana.allow",
    "VirtualHostSupported" : false,
    "DeploymentZoneAccessPoint" : [ {
      "Protocol" : "http",
      "Name" : "default-http0",
      "Address" : "http://ubu1464qa-10.local.akana.com:7901"
    } ]
  } ]
}

Back to top

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

Back to top

Response Body

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

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