Delete Firewall Group
From Hostway API Documentation
(Difference between revisions)
Mike.robski (Talk | contribs) m (1 revision) |
Mike.robski (Talk | contribs) m (1 revision: Release 86) |
||
(One intermediate revision by one user not shown) | |||
Line 1: | Line 1: | ||
This operation will delete the specified firewall group. | This operation will delete the specified firewall group. | ||
− | ='''DELETE''' /os-security-groups/'' | + | ='''DELETE''' /accounts/''{accountId}''/flexcloud/os-security-groups/''{id}''= |
This operation will delete the specified firewall group. | This operation will delete the specified firewall group. | ||
== Parameters == | == Parameters == | ||
− | ; | + | ; accountId - ''string'' |
+ | : The selected account Id. | ||
+ | |||
+ | ; id | ||
: The unique identifier of the firewall group. | : The unique identifier of the firewall group. | ||
Line 18: | Line 21: | ||
'''Successfully delete the specified firewall group''' | '''Successfully delete the specified firewall group''' | ||
− | :'''DELETE''' http(s)://{api_server}/os-security-groups/group2012May11_OK30Zs7Ju | + | :'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-groups/group2012May11_OK30Zs7Ju |
''Request Headers:'' | ''Request Headers:'' | ||
Line 30: | Line 33: | ||
'''Failure while trying to make unauthorized access''' | '''Failure while trying to make unauthorized access''' | ||
− | :'''DELETE''' http(s)://{api_server}/os-security-groups/group2012May11_OK30Zs7Ju | + | :'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-groups/group2012May11_OK30Zs7Ju |
''Request Headers:'' | ''Request Headers:'' | ||
Line 48: | Line 51: | ||
'''Failure while trying to delete a non-existent firewall group''' | '''Failure while trying to delete a non-existent firewall group''' | ||
− | :'''DELETE''' http(s)://{api_server}/os-security-groups/{<span style="color:red">fake_firewall_group_name</span>} | + | :'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-groups/{<span style="color:red">fake_firewall_group_name</span>} |
''Request Headers:'' | ''Request Headers:'' | ||
Line 57: | Line 60: | ||
''Response Code:'' | ''Response Code:'' | ||
<pre>HTTP/1.1 404 Not Found</pre> | <pre>HTTP/1.1 404 Not Found</pre> | ||
+ | |||
+ | '''Failure while trying to pass invalid account number''' | ||
+ | :'''DELETE''' http(s)://{api_server}/accounts/fake/flexcloud/os-security-groups/group2012May11_OK30Zs7Ju | ||
+ | |||
+ | ''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 /os-security-groups/{name} == | ||
+ | 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 /os-security-groups/{name}</code> | ||
[[Category:Hostway API]] | [[Category:Hostway API]] | ||
[[Category:FlexCloud Server API]] | [[Category:FlexCloud Server API]] |
Latest revision as of 11:00, 11 October 2013
This operation will delete the specified firewall group.
Contents |
[edit] DELETE /accounts/{accountId}/flexcloud/os-security-groups/{id}
This operation will delete the specified firewall group.
[edit] Parameters
- accountId - string
- The selected account Id.
- id
- The unique identifier of the firewall group.
[edit] 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.
[edit] Examples
Successfully delete the specified firewall group
- DELETE http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-groups/group2012May11_OK30Zs7Ju
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 make unauthorized access
- DELETE http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-groups/group2012May11_OK30Zs7Ju
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 delete a non-existent firewall group
- DELETE http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-groups/{fake_firewall_group_name}
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 pass invalid account number
- DELETE http(s)://{api_server}/accounts/fake/flexcloud/os-security-groups/group2012May11_OK30Zs7Ju
Response Code:
HTTP/1.1 404 Not Found
Response Body:
{ "itemNotFound" : { "message": "Resource not found", "code": 404, "details": "", "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf" } }
[edit] Alternative URI /os-security-groups/{name}
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 /os-security-groups/{name}