GET /api/deploymentzones
Returns a list of valid deployment zones on the platform, in the form of an RSS channel.
Note: Be sure to include a valid Accept header with this operation. If you don't include the Accept header, the operation might fail in versions later than 8.0, even if it worked in earlier versions.
For more information on deployment zones, refer to Deployment Zones on the Platform.
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
GET
URL
https://{hostname}/api/deploymentzones
In the context of a specific business:
https://{hostname}/api/deploymentzones?ContextID={BusinessID}
Sample Request
The example below requests a list of deployment zones.
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/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 or text/xml application/vnd.soa.v71+json, application/vnd.soa.v71+xml application/vnd.soa.v72+json, application/vnd.soa.v72+xml application/vnd.soa.v80+json, application/vnd.soa.v80+xml |
| Content-Type | Any format (*/*) |
| 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 |
|---|---|---|---|---|
|
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:
|
|
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:
|
Response
If successful, this operation returns HTTP status code 200, with a list of available deployment zones. The information is sent as an RSS channel in JSON or XML format.
Sample Response
The sample response below shows the list of deployment zones returned as an RSS channel.
Sample response headers
HTTP/1.1 200 OK Date: Thu, 23 Jan 2020 23:26:23 GMT Content-Type: application/json
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.
{
"channel":{
"title":"Deployment Zones",
"item":[
{
"title":"container-1721",
"link":"http://gateway.akana.com",
"category":[
{
"value":"Production",
"domain":"uddi:soa.com:environment"
},
{
"value":"Sandbox",
"domain":"uddi:soa.com:environment"
}
],
"guid":{
"value":"container-1721default-http0"
},
"EntityReferences":{
"EntityReference":[
{
"Title":"container-1721",
"Guid":"container-1721.acmepaymentscorp",
"Category":[
{
"value":"dzone",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"container-1531",
"link":"https://gateway.akana.com",
"category":[
{
"value":"Production",
"domain":"uddi:soa.com:environment"
},
{
"value":"Sandbox",
"domain":"uddi:soa.com:environment"
}
],
"guid":{
"value":"container-1531mutual-https"
},
"EntityReferences":{
"EntityReference":[
{
"Title":"container-1531",
"Guid":"container-1531.acmepaymentscorp",
"Category":[
{
"value":"dzone",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
}
]
},
"version":"1.0"
}
Sample response body #2
In the example below, the request was in the context of a sub-organization (ContextID parameter included).
{
"channel": {
"title": "Deployment Zones",
"item": [
{
"title": "container-1721",
"link": "http://gateway.akana.com",
"category": [
{
"value": "Production",
"domain": "uddi:soa.com:environment"
},
{
"value": "Sandbox",
"domain": "uddi:soa.com:environment"
}
],
"guid": {
"value": "container-1721default-http0"
},
"EntityReferences": {
"EntityReference": [
{
"Title": "container-1721",
"Guid": "container-1721.acmepaymentscorp",
"Category": [
{
"value": "dzone",
"domain": "uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title": "container-1531",
"link": "https://gateway.akana.com",
"category": [
{
"value": "Production",
"domain": "uddi:soa.com:environment"
},
{
"value": "Sandbox",
"domain": "uddi:soa.com:environment"
}
],
"guid": {
"value": "container-1531mutual-https"
},
"EntityReferences": {
"EntityReference": [
{
"Title": "container-1531",
"Guid": "container-1531.acmepaymentscorp",
"Category": [
{
"value": "dzone",
"domain": "uddi:soa.com:resourcetype"
}
]
}
]
}
}
]
},
"version": "1.0"
}
Response Headers
For general information on response header values, refer to HTTP Response Headers.
| Header | Description |
|---|---|
| Content-Type |
application/json or text/xml application/vnd.soa.v71+json, application/vnd.soa.v71+xml application/vnd.soa.v72+json, application/vnd.soa.v72+xml application/vnd.soa.v80+json, application/vnd.soa.v80+xml |
Response Body
The response body is an RSS channel titled Deployment Zones, which includes an array of one or more deployment zone items. Each item includes the fields listed below.
| Name | Description |
|---|---|
| Title | Title of the deployment zone. |
| Link | URL for the deployment zone. |
| Description | Description of the deployment zone. |
| Category | One or more categories, each with a value of Sandbox or Production, and each with a Domain property. |
| GUID | GUID for the deployment zone. |
| Entity references |
One or more entity references. Each includes:
|
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.