Delete a Zone¶
Overview¶
- Delete a zone.
Classification¶
- Delete
API Operation Object¶
- Zone
Synchronous / Asynchronous¶
- Synchronous
Request¶
HTTP Request Method¶
- DELETE
HTTP Request Path¶
{api_endpoint}/v2/zones/{zone_id}
HTTP Request Header¶
Format¶
Content-Type: application/json
Accept: application/json
X-Auth-Token: <token_id>
Request Parameter¶
| name | style | format | description | required/optional | default value | action for invalid parameter | response code for invalid parameter |
|---|---|---|---|---|---|---|---|
| token_id | header | authentication token string | authentication token. | required | - | Terminate | 401 |
| zone_id | path | uuid | ID for the zone | required | - | Terminate | 404 |
HTTP Request Body¶
- none
Response¶
HTTP Response Header¶
Response Code¶
| response code | status | condition | message |
|---|---|---|---|
| 202 | Accepted | normal end | |
| 404 | Not Found | not found | E2007 Specified zone is not found. |
| 401 | Unauthorized | authentication failure | E2001 Invalid token. |
| 500 | Internal Server Error | internal server error | E9001 Internal Server Error. Request failed. |
Response Body¶
- none
Sample Request and Response¶
Sample API Request¶
Request URL¶
DELETE /v2/zones/7f0e3541-9fc6-410d-b338-087909f04ebc
Request Header¶
Content-Type: application/json
Accept: application/json
X-Auth-Token: e8c788fbaeb14964ae19759eb1df4ff1
Request Body¶
- none
Sample API Response¶
Response Header¶
HTTP/1.1 202
Date: Mon, 24 Oct 2016 03:32:01 GMT
Content-Length: 0
Connection: keep-alive
Set-Cookie: TS0183560f=01cce65ce1e91b128a2939b9b36c3bcdbea6b9765585cb5bed621e78d291d2e95f24a044c8; Path=/
Response Body¶
- none
Sample Error Response¶
Response¶
HTTP/1.1 400
Date: Mon, 24 Oct 2016 01:30:36 GMT
Content-Type: application/json
Content-Length: 111
Connection: keep-alive
Set-Cookie: TS0183560f=01cce65ce1828fac503bbbf6997eb1396e2a3b7f1a6e963369567ce837536e7a802f7b85c3; Path=/
{"error":{"code":404,"title":"Not Found","message":"E2007 Specified zone is not found."}}