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.

Note: At this time, there is no interface to manage deployment zones in the platform. Deployment zone configuration is optional. Deployment zones are loaded in the DEPLOY_ZONES and DEPLOY_ZONE_CONTAINER tables using a database script. If no deployment zones are configured, the platform API constructs transient deployment zones based on the deployment configuration of the agents available for the platform to host API proxy endpoints. To manage the deployment zones in the platform, contact tech support.

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

Back to top

URL

https://{hostname}/api/deploymentzones[?][ApiID={APIID}]

Back to top

Sample Request

The example below requests a list of deployment zones.

Sample request URL

https://{hostname}/api/deploymentzones

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.

Back to top

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 (*/*)
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.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
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 a list of available deployment zones. The information is sent as an RSS channel in JSON or XML format.

Back to top

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: Mon, 30 Jul 2018 20:10:06 GMT
Content-Type: application/json

Sample response body: application/json

{
  "channel": {
    "title": "Deployment Zones",
    "item": [
      {
        "title": "ed33-ae99-463a-b663-75710bdb67fb",
        "link": "http://ubu1464qa-10.local.akana.com:7905",
        "category": [
          {
            "value": "Production",
            "domain": "uddi:soa.com:environment"
          },
          {
            "value": "Sandbox",
            "domain": "uddi:soa.com:environment"
          }
        ],
        "guid": {
          "value": "ed33-ae99-463a-b663-75710bdb67fbdefault-http0"
        },
        "EntityReferences": {
          "EntityReference": [
            {
              "Title": "ed33-ae99-463a-b663-75710bdb67fb",
              "Guid": "ed33-ae99-463a-b663-75710bdb67fb.acmepaymentscorp",
              "Category": [
                {
                  "value": "dzone",
                  "domain": "uddi:soa.com:resourcetype"
                }
              ]
            }
          ]
        }
      }
    ]
  },
  "version": "1.0"
}

Sample response body: text/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<rss xmlns:ns2="http://soa.com/xsd/business/1.0" xmlns:ns3="http://soa.com/xsd/user/1.0" xmlns:ns4="http://soa.com/xsd/rss/1.0" xmlns:ns5="http://a9.com/-/spec/opensearch/1.1/" xmlns:ns6="http://soa.com/xsd/comment/1.0" xmlns:ns7="http://soa.com/xsd/board/1.0" xmlns:ns8="http://soa.com/xsd/dnmodel/1.0" xmlns:ns9="http://soa.com/xsd/resource/1.0" xmlns:ns10="http://soa.com/xsd/legals/1.0" xmlns:ns11="http://soa.com/xsd/fault/1.0" xmlns:ns12="http://soa.com/xsd/api/1.0" xmlns:ns13="http://soa.com/xsd/deploymentzone/1.0" xmlns:ns14="http://soa.com/xsd/asset/1.0" xmlns:ns15="http://soa.com/xsd/ticket/1.0" xmlns:ns16="http://soa.com/xsd/app/1.0" xmlns:ns17="http://soa.com/xsd/review/1.0" xmlns:ns18="http://soa.com/xsd/alert/1.0" xmlns:ns19="http://soa.com/xsd/contract/1.0" xmlns:ns20="http://soa.com/xsd/discussion/1.0" xmlns:ns21="http://soa.com/xsd/search/1.0" xmlns:ns22="http://soa.com/xsd/workflow/1.0" xmlns:ns23="http://soa.com/xsd/client/services/1.0" xmlns:ns24="http://soa.com/xsd/oauth/1.0" version="1.0">
  <channel>
    <title>Deployment Zones</title>
    <item>
      <title>ed33-ae99-463a-b663-75710bdb67fb</title>
      <link>http://ubu1464qa-10.local.akana.com:7905</link>
      <category domain="uddi:soa.com:environment">Production</category>
      <category domain="uddi:soa.com:environment">Sandbox</category>
      <guid>ed33-ae99-463a-b663-75710bdb67fbdefault-http0</guid>
      <ns4:EntityReferences>
        <ns4:EntityReference>
          <Title>ed33-ae99-463a-b663-75710bdb67fb</Title>
          <Guid>ed33-ae99-463a-b663-75710bdb67fb.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">dzone</ns4:Category>
        </ns4:EntityReference>
      </ns4:EntityReferences>
    </item>
  </channel>
</rss>

Back to top

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

Back to top

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:

  • Title
  • GUID: the unique ID for the item.
  • Category

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. 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.

Back to top

Related Topics