Delete Allocated Flexible IP

From Hostway API Documentation
(Difference between revisions)
Jump to: navigation, search
m (1 revision: Release 86)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
This operation will delete the specified allocated flexible IP address.
 
This operation will delete the specified allocated flexible IP address.
  
=='''DELETE''' /os-floating-ips/'''ip_address'''==
+
='''DELETE''' /accounts/''{accountId}''/flexcloud/os-floating-ips/''{ip_address}''=
 
Deletes and deallocates the specified allocated flexible IP address.
 
Deletes and deallocates the specified allocated flexible IP address.
  
=== Parameters ===
+
== Parameters ==
 +
; accountId - ''string''
 +
: The selected account Id.
 +
 
 
; ip_address - ''string''
 
; ip_address - ''string''
  
=== Response Codes ===
+
== Response Codes ==
 
; Success:
 
; Success:
 
:''HTTP/1.1 202 Accepted''
 
:''HTTP/1.1 202 Accepted''
Line 14: Line 17:
 
:''HTTP/1.1 404 Not Found'' - The resource does not exist.
 
:''HTTP/1.1 404 Not Found'' - The resource does not exist.
  
=== Examples ===
+
== Examples ==
  
 
'''Delete the specified allocated flexible IP address'''
 
'''Delete the specified allocated flexible IP address'''
:'''DELETE''' http(s)://{api_server}/os-floating-ips/{ip_address}
+
:'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-floating-ips/{ip_address}
  
 
''Request Headers:''
 
''Request Headers:''
Line 28: Line 31:
  
 
'''Failure while trying to delete a non-existent allocated floating IP address'''
 
'''Failure while trying to delete a non-existent allocated floating IP address'''
:'''DELETE''' http(s)://{api_server}/os-floating-ips/{<span style="color:red">fake_ip_address</span>}
+
:'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-floating-ips/{<span style="color:red">fake_ip_address</span>}
  
 
''Request Headers:''
 
''Request Headers:''
Line 39: Line 42:
  
 
'''Unauthorized access'''
 
'''Unauthorized access'''
:'''DELETE''' http(s)://{api_server}/os-floating-ips/{ip_address}
+
:'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-floating-ips/{ip_address}
  
 
''Request Headers:''
 
''Request Headers:''
Line 56: Line 59:
 
     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-floating-ips/{ip_address}
  
[[Category:Hostway API]]
+
''Response Code:''
[[Category:FlexCloud Server API]]
+
<pre>HTTP/1.1 404 Not Found</pre>
  
<!-- THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING-->
+
''Response Body:''
 +
<nowiki>
 +
  {
 +
    "itemNotFound" : {
 +
      "message": "Resource not found",
 +
      "code": 404,
 +
      "details": "",
 +
      "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
 +
    }
 +
}</nowiki>
  
{{#widget:DISQUS
+
== Alternative URI /os-floating-ips/{ip_address} ==
|id=hostway
+
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]].
|uniqid={{PAGENAME}}
+
|url={{fullurl:{{PAGENAME}}}}
+
}}
+
  
<!--  ########################################################################### -->
+
<code>DELETE /os-floating-ips/{ip_address}</code>
 +
 
 +
[[Category:Hostway API]]
 +
[[Category:FlexCloud Server API]]

Latest revision as of 11:00, 11 October 2013

This operation will delete the specified allocated flexible IP address.

Contents

DELETE /accounts/{accountId}/flexcloud/os-floating-ips/{ip_address}

Deletes and deallocates the specified allocated flexible IP address.

Parameters

accountId - string
The selected account Id.
ip_address - string

Response Codes

Success
HTTP/1.1 202 Accepted
Failure
HTTP/1.1 401 Unauthorized - This server could not verify that you are authorized to access the document you requested. Either you supplied incorrect 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

Delete the specified allocated flexible IP address

DELETE http(s)://{api_server}/accounts/{accountId}/flexcloud/os-floating-ips/{ip_address}

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

Response Code:

HTTP/1.1 202 Accepted

Failure while trying to delete a non-existent allocated floating IP address

DELETE http(s)://{api_server}/accounts/{accountId}/flexcloud/os-floating-ips/{fake_ip_address}

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

Response Code:

HTTP/1.1 404 Not Found

Unauthorized access

DELETE http(s)://{api_server}/accounts/{accountId}/flexcloud/os-floating-ips/{ip_address}

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-floating-ips/{ip_address}

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 /os-floating-ips/{ip_address}

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-floating-ips/{ip_address}

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox