View source

A Flexible IP address is a static IP address that can be bound to any single Server. When you associate a flexible IP with a Server the IP is bound to that Server's network interface. You will use your flexible IP to connect to your Server. You can allocate IPs and release IPs from your account as needed.

='''POST''' /accounts/{accountId}/flexcloud/os-floating-ips=
Allocates a new flexible IP.

== Request ==
 <nowiki>
{
    "zone": "AUS001"
}</nowiki>

=== Parameters ===
; accountId - ''string''
: The selected account Id.

== Response ==
=== JSON ===
 <nowiki>
{
   "floating_ip" : {
      "instance_id" : "{instance_id}", 
      "ip" : "{ip_address}", 
      "fixed_ip" : null, 
      "links" : [
         {
            "href" : "http://{api_server}/accounts/{accountId}/flexcloud/os-floating-ips/{ip_address}/", 
            "rel" : "self"
         }
      ], 
      "pool" : "default"
   }
}</nowiki>

====floating_ip====
; instance_id - ''string''
: Unique instance identifier floating IP is assigned to.

; ip - ''string''
: IP address allocated.

; fixed_ip - ''string''
: Fixed IP address.

; links - ''list''
: [[Hypermedia]] for this resource.

; pool - ''string''
: Name of the pool IP address belongs to.

== 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 Resource not found'' : The resource was accessed with wrong account number

== Examples ==
'''Successfully allocate a flexible IP'''
:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-floating-ips

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

''Response Code:''
<pre>HTTP/1.1 202 Accepted</pre>

''Response Body:''
 <nowiki>
{
   "floating_ip" : {
      "instance_id" : null, 
      "ip" : "{ip_address}", 
      "fixed_ip" : null, 
      "links" : [
         {
            "href" : "http://{api_server}/account/{accountId}/flexcloud/os-floating-ips/{ip_address}/", 
            "rel" : "self"
         }
      ], 
      "pool" : "default"
   } 
}</nowiki>

'''Unauthorized access'''
:'''POST''' <nowiki>http://{api_server}/accounts/{accountId}/flexcloud/os-floating-ips</nowiki>

''Request Headers:''
    Content-Type:application/json
    Charset=UTF-8
    Authorization:Base64-encoded <span style="color:red">fake_authentication_string</span>

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''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'''
:'''POST''' <nowiki>http://{api_server}/accounts/fake/flexcloud/os-floating-ips</nowiki>

''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-floating-ips ==
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>POST /os-floating-ips</code>

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]