Delete Volume
From Hostway API Documentation
(Difference between revisions)
(Created page with "This operation will delete a single volume. ='''DELETE''' /volumes/'''id'''= This operation will delete a single volume. == Parameters == ; id - ''string'' : The unique volu...") |
Mike.robski (Talk | contribs) m (1 revision: Release 86) |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
This operation will delete a single volume. | This operation will delete a single volume. | ||
| − | ='''DELETE''' / | + | ='''DELETE''' /accounts/''{accountId}''/flexcloud/volumes/''{id}''= |
This operation will delete a single volume. | This operation will delete a single volume. | ||
== Parameters == | == Parameters == | ||
| + | ; accountId - ''string'' | ||
| + | : The selected account Id. | ||
| + | |||
; id - ''string'' | ; id - ''string'' | ||
: The unique volume identifier. | : The unique volume identifier. | ||
| Line 18: | Line 21: | ||
'''Successfully delete the specified volume''' | '''Successfully delete the specified volume''' | ||
| − | :'''DELETE''' http(s)://{api_server}/volumes/{volume_id} | + | :'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/volumes/{volume_id} |
''Request Headers:'' | ''Request Headers:'' | ||
| Line 29: | Line 32: | ||
'''Failure while trying to delete a non-existent volume''' | '''Failure while trying to delete a non-existent volume''' | ||
| − | :'''DELETE''' http(s)://{api_server}/volumes/{<span style="color:red">fake_volume_id</span>} | + | :'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/volumes/{<span style="color:red">fake_volume_id</span>} |
''Request Headers:'' | ''Request Headers:'' | ||
| Line 40: | Line 43: | ||
'''Failure while trying to make an unauthorized access''' | '''Failure while trying to make an unauthorized access''' | ||
| − | :'''DELETE''' http(s)://{api_server}/volumes/{volume_id} | + | :'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/volumes/{volume_id} |
''Request Headers:'' | ''Request Headers:'' | ||
| Line 57: | Line 60: | ||
does not understand how to supply the credentials required. | does not understand how to supply the credentials required. | ||
| + | '''Failure while trying to pass invalid account number''' | ||
| + | :'''DELETE''' http(s)://{api_server}/accounts/fake/flexcloud/volumes/{volume_id} | ||
| + | |||
| + | ''Response Code:'' | ||
| + | <pre>HTTP/1.1 404 Not Found</pre> | ||
| + | |||
| + | ''Response Body:'' | ||
| + | <nowiki> | ||
| + | { | ||
| + | "itemNotFound" : { | ||
| + | "message": "Resource not found", | ||
| + | "code": 404, | ||
| + | "details": "", | ||
| + | "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf" | ||
| + | } | ||
| + | }</nowiki> | ||
| − | + | == Alternative URI /volumes/{volume_id} == | |
| + | An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]]. | ||
| − | { | + | <code>DELETE /volumes/{volume_id}</code> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | [[Category:Hostway API]] | |
| + | [[Category:FlexCloud Server API]] | ||
Latest revision as of 11:00, 11 October 2013
This operation will delete a single volume.
Contents |
DELETE /accounts/{accountId}/flexcloud/volumes/{id}
This operation will delete a single volume.
Parameters
- accountId - string
- The selected account Id.
- id - string
- The unique volume identifier.
Response Codes
- Success
- HTTP/1.1 204 No Content
- Failure
- HTTP/1.1 401 Unauthorized - This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
- HTTP/1.1 404 Not Found - The resource does not exist.
Examples
Successfully delete the specified volume
- DELETE http(s)://{api_server}/accounts/{accountId}/flexcloud/volumes/{volume_id}
Request Headers:
Content-Type:application/json Charset=UTF-8 Authorization:Base64-encoded username & password string
Response Code:
HTTP/1.1 204 No Content
Failure while trying to delete a non-existent volume
- DELETE http(s)://{api_server}/accounts/{accountId}/flexcloud/volumes/{fake_volume_id}
Request Headers:
Content-Type:application/json Charset=UTF-8 Authorization:Base64-encoded username & password string
Response Code:
HTTP/1.1 404 Not Found
Failure while trying to make an unauthorized access
- DELETE http(s)://{api_server}/accounts/{accountId}/flexcloud/volumes/{volume_id}
Request Headers:
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string
Response Code:
HTTP/1.1 401 Unauthorized
Response Body:
401 Unauthorized
This server could not verify that you are authorized to
access the document you requested. Either you supplied the
wrong credentials (e.g., bad password), or your browser
does not understand how to supply the credentials required.
Failure while trying to pass invalid account number
- DELETE http(s)://{api_server}/accounts/fake/flexcloud/volumes/{volume_id}
Response Code:
HTTP/1.1 404 Not Found
Response Body:
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}
Alternative URI /volumes/{volume_id}
An alternative way to execute this call is to omit the accountId portion of the URI. In this case the system assumes the request is executed for the account identified in the authorization header.
DELETE /volumes/{volume_id}
