DELETE /api/deploymentzones/{DZoneID}

Deletes a deployment zone on the platform.

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

This topic includes the following sections:

HTTP Method


Back to top



Back to top

Sample Request

The example below shows a request to delete the specified deployment zone.

Request URL


Sample request headers

DELETE /api/deploymentzones/cb5502a0-7780-470f-8bda-c41f53659689.acmepaymentscorp HTTP/1.1
Accept: text/plain
Content-Type: application/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 Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
DZoneID Path string Required Unique ID for a specific deployment zone.

Back to top


If successful, this operation returns HTTP status code 200, with the Deployment Zone ID in plain text.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Date: Mon, 27 Jun 2016 18:27:37 GMT
Content-Type: text/plain

Sample response body


Back to top

Response Headers

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

Header Description
Content-Type text/plain

Back to top

Response Body

Name Type Description
DZoneID string Unique ID for a specific deployment zone.

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