Delete Firewall Group Rule

From Hostway API Documentation
(Difference between revisions)
Jump to: navigation, search
m (1 revision: Release 86)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
This operation will delete a firewall group rule.
 
This operation will delete a firewall group rule.
  
='''DELETE''' /os-security-group-rules/'''id'''=
+
='''DELETE''' /accounts/''{accountId}''/flexcloud/os-security-group-rules/''{id}''=
 
This operation will delete a firewall group rule.
 
This operation will delete a firewall group rule.
  
 
== Parameters ==
 
== Parameters ==
 +
; accountId - ''string''
 +
: The selected account Id.
 +
 
; id - ''string''
 
; id - ''string''
 
: The unique firewall group rule identifier.
 
: The unique firewall group rule identifier.
Line 18: Line 21:
  
 
'''Successfully delete the specified firewall group rule'''
 
'''Successfully delete the specified firewall group rule'''
:'''DELETE''' http(s)://{api_server}/os-security-group-rules/{firewall_group_rule_id}
+
:'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-group-rules/{firewall_group_rule_id}
  
 
''Request Headers:''
 
''Request Headers:''
Line 29: Line 32:
  
 
'''Failure while trying to delete a non-existent firewall group rule'''
 
'''Failure while trying to delete a non-existent firewall group rule'''
:'''DELETE''' http(s)://{api_server}/os-security-group-rules/{<span style="color:red">fake_firewall_group_rule_id</span>}
+
:'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-group-rules/{<span style="color:red">fake_firewall_group_rule_id</span>}
  
 
''Request Headers:''
 
''Request Headers:''
Line 40: Line 43:
  
 
'''Failure while trying to make unauthorized access'''
 
'''Failure while trying to make unauthorized access'''
:'''DELETE''' http(s)://{api_server}/os-security-group-rules/{firewall_group_rule_id}
+
:'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-group-rules/{firewall_group_rule_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/os-security-group-rules/{firewall_group_rule_id}
  
[[Category:API]]
+
''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>
  
<!-- THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING-->
+
== Alternative URI /os-security-group-rules/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]].
  
{{#widget:DISQUS
+
<code>DELETE /os-security-group-rules/{id}</code>
|id=hostway
+
|uniqid={{PAGENAME}}
+
|url={{fullurl:{{PAGENAME}}}}
+
}}
+
  
<!--  ########################################################################### -->
+
[[Category:Hostway API]]
 +
[[Category:FlexCloud Server API]]

Latest revision as of 12:00, 11 October 2013

This operation will delete a firewall group rule.

Contents

[edit] DELETE /accounts/{accountId}/flexcloud/os-security-group-rules/{id}

This operation will delete a firewall group rule.

[edit] Parameters

accountId - string
The selected account Id.
id - string
The unique firewall group rule identifier.

[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 rule

DELETE http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-group-rules/{firewall_group_rule_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 firewall group rule

DELETE http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-group-rules/{fake_firewall_group_rule_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 unauthorized access

DELETE http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-group-rules/{firewall_group_rule_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/os-security-group-rules/{firewall_group_rule_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"
    }
 }

[edit] Alternative URI /os-security-group-rules/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 /os-security-group-rules/{id}

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox