ListServerIPs - Revision history

Mike.robski: 1 revision: Release 86

2013-10-11T17:00:57Z

1 revision: Release 86

Emanuela.mitreva at 16:50, 11 July 2013

2013-07-11T16:50:37Z

Mike.robski: 1 revision

2013-05-24T15:24:59Z

1 revision

Mike.robski at 13:13, 20 May 2013

2013-05-20T13:13:41Z

Administrator at 01:16, 13 April 2013

2013-04-13T01:16:59Z

Mike.robski at 22:35, 14 December 2012

2012-12-14T22:35:50Z

Mike.robski at 20:34, 14 December 2012

2012-12-14T20:34:27Z

Administrator: Created page with "This operation will list all flexible IPs assigned to a specific Server. ='''GET''' /servers/'''id'''/ips''= == Parameters == ; id : The unique identifier of the server...."

2012-07-04T21:16:57Z

Created page with "This operation will list all flexible IPs assigned to a specific Server. ='''GET''' /servers/'''id'''/ips''= == Parameters == ; id : The unique identifier of the server...."

New page

This operation will list all flexible IPs assigned to a specific [[Server]].

='''GET''' /servers/'''id'''/ips''=

== Parameters ==
; id
: The unique identifier of the server.

== Result ==
=== JSON ===
<nowiki>
{
"addresses" : {
"public" : [
{
"version" : 4,
"addr" : "{ip_address}"
}
],
"private" : [
{
"version" : 4,
"addr" : "{ip_address}"
}
]
},
"links" : [
{
"href" : "http://{api_server}/servers/{server_id}/ips",
"rel": "self"
}
]
}
</nowiki>

; addr - ''string''
: The address of the allocated flexible IP.

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

== Response Codes ==
; Success:
:''HTTP/1.1 200 OK''
; 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'' - Resource not found.

== Examples ==

'''Successfully list all flexible IPs assigned to the specified server'''
:'''GET''' http(s)://{api_server}/servers/test_server_0013/ips

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

''Response Code:''
<pre>HTTP/1.1 200 OK</pre>

''Response Body:''
<nowiki>
{
"addresses" : {
"public" : [
{
"version" : 4,
"addr" : "{ip_address}"
}
],
"private" : [
{
"version" : 4,
"addr" : "{ip_address}"
}
]
},
"links" : [
{
"href" : "http://{api_server}/servers/test_server_0013/ips",
"rel": "self"
}
]
}
</nowiki>

'''Unauthorized access'''
:'''GET''' http(s)://{api_server}/servers/test_server_0013/ips

''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 list flexible IPs for a non-existent server'''
:'''GET''' http(s)://{api_server}/servers/{<span style="color:red">fake_server_id</span>}/ips

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

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": ""
}
}



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

← Older revision		Revision as of 01:16, 13 April 2013
Line 1:		Line 1:
−	~~=='''GET''' /servers/'''id'''/ips''==~~
	This operation will list all flexible IPs assigned to a specific [[Server]].		This operation will list all flexible IPs assigned to a specific [[Server]].
		+
		+	=='''GET''' /servers/'''id'''/ips''==

	=== Parameters ===		=== Parameters ===

← Older revision		Revision as of 20:34, 14 December 2012
Line 127:		Line 127:
	}		}

		+
		+	[[Category:API]]

	<!-- THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING-->		<!-- THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING-->

@@ Line 1: / Line 1: @@
 This operation will list all flexible IPs assigned to a specific [[Server]].
-='''GET''' /servers/'''id'''/ips''=
+='''GET''' /accounts/''{accountId}''/flexcloud/servers/''{id}''/ips''=
 == Parameters ==
 ; id
 : The unique identifier of the server.
@@ Line 27: / Line 30: @@
     "links" : [
+       {
-          "href" : "http://{api_server}/servers/{server_id}/ips",
+          "href" : "http://{api_server}/accounts/{accountId}/flexcloud/servers/{server_id}/ips",
           "rel": "self"
+       }
+    ]
 }</nowiki>
 </nowiki>
 ; addr - ''string''
@@ Line 50: / Line 52: @@
 '''Successfully list all flexible IPs assigned to the specified server'''
-:'''GET''' http(s)://{api_server}/servers/test_server_0013/ips
+:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/ips
@@ Line 80: / Line 82: @@
     "links" : [
+       {
-          "href" : "http://{api_server}/servers/test_server_0013/ips",
+          "href" : "http://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/ips",
           "rel": "self"
+       }
+    ]
 }</nowiki>
 </nowiki>
 '''Unauthorized access'''
-:'''GET''' http(s)://{api_server}/servers/test_server_0013/ips
+:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/ips
@@ Line 107: / Line 108: @@
 '''Failure while trying to list flexible IPs for a non-existent server'''
-:'''GET''' http(s)://{api_server}/servers/{<span style="color:red">fake_server_id</span>}/ips
+:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{<span style="color:red">fake_server_id</span>}/ips
@@ Line 119: / Line 120: @@
 ''Response Body:''
+  {
      "itemNotFound" : {
@@ Line 126: / Line 128: @@
         "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
+     }
+  }</nowiki>
 [[Category:Hostway API]]
 [[Category:FlexCloud Server API]]

@@ Line 1: / Line 1: @@
 This operation will list all flexible IPs assigned to a specific [[Server]].
-=='''GET''' /servers/'''id'''/ips''==
+='''GET''' /servers/'''id'''/ips''=
-=== Parameters ===
+== Parameters ==
 ; id
 : The unique identifier of the server.
-=== Result ===
+== Result ==
-==== JSON ====
+=== JSON ===
   <nowiki>
+{
@@ Line 40: / Line 40: @@
 : [[Hypermedia]] for this resource.
-=== Response Codes ===
+== Response Codes ==
 ; Success:
 :''HTTP/1.1 200 OK''
@@ Line 47: / Line 47: @@
 :''HTTP/1.1 404 Not Found'' - Resource not found.
-=== Examples ===
+== Examples ==
 '''Successfully list all flexible IPs assigned to the specified server'''
@@ Line 123: / Line 123: @@
         "message": "Resource not found",
         "code": 404,
-        "details": ""
+        "details": "",
+     }
+  }
@@ Line 129: / Line 130: @@
 [[Category:Hostway API]]
 [[Category:FlexCloud Server API]]