ServerActionAddFlexibleIP

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 assign an already allocated flexible IP to the specified [[server]].
 
This operation will assign an already allocated flexible IP to the specified [[server]].
  
='''POST''' /servers/'''id'''/action=
+
='''POST''' /accounts/''{accountId}''/flexcloud/servers/''{id}''/action=
  
 
== Parameters ==
 
== Parameters ==
 +
; accountId - ''string''
 +
: The selected account Id.
 +
 
; id
 
; id
 
: The unique identifier of the server.
 
: The unique identifier of the server.
Line 27: Line 30:
 
: ''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 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 403 Forbidden'' : The server understood the request, but is refusing to fulfill it. The IP address specified is already assigned to another resource instance.
 
: ''HTTP/1.1 403 Forbidden'' : The server understood the request, but is refusing to fulfill it. The IP address specified is already assigned to another resource instance.
 +
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.
 
: ''HTTP/1.1 409 Conflict'' : Server not provisioned.  
 
: ''HTTP/1.1 409 Conflict'' : Server not provisioned.  
 
: ''HTTP/1.1 502 Bad Gateway'' : Error while assigning IP address ... / Invalid data received when assigning IP address ...
 
: ''HTTP/1.1 502 Bad Gateway'' : Error while assigning IP address ... / Invalid data received when assigning IP address ...
  
 +
== Alternative URI /servers/{id}/action ==
 +
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]].
  
[[Category:API]]
+
<code>POST /servers/{id}/action</code>
 
+
<!--  THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING-->
+
 
+
{{#widget:DISQUS
+
|id=hostway
+
|uniqid={{PAGENAME}}
+
|url={{fullurl:{{PAGENAME}}}}
+
}}
+
  
<!--  ########################################################################### -->
+
[[Category:Hostway API]]
 +
[[Category:FlexCloud Server API]]

Latest revision as of 11:00, 11 October 2013

This operation will assign an already allocated flexible IP to the specified server.

Contents

[edit] POST /accounts/{accountId}/flexcloud/servers/{id}/action

[edit] Parameters

accountId - string
The selected account Id.
id
The unique identifier of the server.

[edit] Request

[edit] JSON

{
   "addFloatingIp" :
      {
         "address" : {ip_address}
      }
}
address - string
The address of the allocated floating IP.

[edit] Response Codes

Success
HTTP/1.1 202 Accepted : The request is accepted for processing.
Failure
HTTP/1.1 400 Bad Request : Check your parameter (no address in JSON). / Server Not Found.
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 403 Forbidden : The server understood the request, but is refusing to fulfill it. The IP address specified is already assigned to another resource instance.
HTTP/1.1 404 Not Found : The resource requested is not found.
HTTP/1.1 409 Conflict : Server not provisioned.
HTTP/1.1 502 Bad Gateway : Error while assigning IP address ... / Invalid data received when assigning IP address ...

[edit] Alternative URI /servers/{id}/action

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.

POST /servers/{id}/action

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox