PUT /api/deploymentzones/{DZoneID}

Updates information about a deployment zone on the platform.

Authorization Roles/Permissions: Must have Modify permission for the resource. For example, a Business Admin.

This topic includes the following sections:

HTTP Method

PUT

Back to top

URL

https://{hostname}/api/deploymentzones/{DZoneID}

Back to top

Sample Request

The example below shows a request to update the information about a deployment zone.

Request URL

https://{hostname}/api/deploymentzones/4hrNPFUYSpq5jeju_Vk5PA.acmepaymentscorp

Sample request headers

PUT /api/deploymentzones/4hrNPFUYSpq5jeju_Vk5PA.acmepaymentscorp HTTP/1.1
Accept: application/json, text/javascript, */*; q=0.01
Content-Type: application/json
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body #1

{
  "DeploymentZoneID":"3ed6bf3e-5b8c-40e4-a352-0861dfb5f77a.acmepaymentscorp",
  "Name":"DZ1",
  "Description":"",
  "ContainerKey":"54cf-1819-4d0e-b84d-c4af73491ed0",
  "AddressOverrideBehavior":"com.akana.dontallow",
  "RandomHostNameBehavior":"com.akana.dontallow",
  "VirtualHostSupported":true,
  "DeploymentZoneAccessPoint":[
    {
      "Protocol":"http",
      "Name":"default-http0",
      "Address":"http://ubu1464qa-10.local.akana.com:7905"
    }
  ]
}

Sample request body #2

In the example below, AddressOverrideBehavior is set to com.akana.allow, so the HostName field is included, with the hostname that is allowed to override the API Gateway hostname.

{
  "DeploymentZoneID":"3ed6bf3e-5b8c-40e4-a352-0861dfb5f77a.acmepaymentscorp",
  "Name":"Name Change",
  "Description":"Description Change",
  "ContainerKey":"54cf-1819-4d0e-b84d-c4af73491ed0",
  "AddressOverrideBehavior":"com.akana.allow",
  "RandomHostNameBehavior":"com.akana.allow",
  "HostName":"example.com",
  "VirtualHostSupported":true,
  "DeploymentZoneAccessPoint":[
    {
      "Protocol":"http",
      "Name":"default-http0",
      "Address":"http://example.com:7905"
    }
  ]
}

Back to top

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

Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json or application/xml

application/vnd.soa.v81+json or application/vnd.soa.v81+xml

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
DZoneID Path string Required Unique ID for a specific deployment zone.
deploymentZoneInfo Body DeploymentZoneInfo Required Contains information about a specific deployment zone on the platform.

Back to top

Response

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

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Mon, 06 Aug 2018 17:53:29 GMT

Sample response body: application/json

{
    "DZoneEnvImplAssociations": {
        "DZoneEnvImplAssociation": [
            {
                "Implementation": "Live",
                "Environment": "Production"
            },
            {
                "Implementation": "Sandbox",
                "Environment": "Production"
            }
        ]
    },
    "DeploymentZoneID": "3ed6bf3e-5b8c-40e4-a352-0861dfb5f77a.acmepaymentscorp",
    "Name": "Name Change",
    "Description": "Description Change",
    "ContainerKey": "54cf-1819-4d0e-b84d-c4af73491ed0",
    "ContainerName": "eapNdTrunk",
    "AddressOverrideBehavior": "com.akana.allow",
    "RandomHostNameBehavior": "com.akana.allow",
    "HostName": "example.com",
    "VirtualHostSupported": true,
    "DeploymentZoneAccessPoint": [
        {
            "Protocol": "http",
            "Name": "default-http0",
            "Address": "http://example.com:7905"
        }
    ]
}

Back to top

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

Back to top

Response Body

Name Type Description
DeploymentZoneInfo DeploymentZoneInfo Contains information about a specific deployment zone on the platform.

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.
405 Method Not Allowed. For example, you might get this if you specified an invalid Accept header or omitted a required Content-Type header, or used the wrong HTTP verb.
415 Unsupported Media Type; returned if the request is using a media type not supported by the method. For example, you would get this response if you used an unsupported media type for the Accept header.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics