ListServerIPs
(Difference between revisions)
Mike.robski (Talk | contribs) |
Mike.robski (Talk | contribs) |
||
| 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]]. | ||
| − | = | + | === Parameters === |
| − | + | ||
| − | == Parameters == | + | |
; id | ; id | ||
: The unique identifier of the server. | : The unique identifier of the server. | ||
| − | == Result == | + | === Result === |
| − | === JSON === | + | ==== JSON ==== |
<nowiki> | <nowiki> | ||
{ | { | ||
| Line 40: | Line 39: | ||
: [[Hypermedia]] for this resource. | : [[Hypermedia]] for this resource. | ||
| − | == Response Codes == | + | === Response Codes === |
; Success: | ; Success: | ||
:''HTTP/1.1 200 OK'' | :''HTTP/1.1 200 OK'' | ||
| Line 47: | Line 46: | ||
:''HTTP/1.1 404 Not Found'' - Resource not found. | :''HTTP/1.1 404 Not Found'' - Resource not found. | ||
| − | == Examples == | + | === Examples === |
'''Successfully list all flexible IPs assigned to the specified server''' | '''Successfully list all flexible IPs assigned to the specified server''' | ||
| Line 127: | Line 126: | ||
} | } | ||
| − | + | [[Category:Hostway API]] | |
| − | [[Category:API]] | + | [[Category:FlexCloud Server 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--> | ||
Revision as of 16:35, 14 December 2012
Contents |
GET /servers/id/ips
This operation will list all flexible IPs assigned to a specific Server.
Parameters
- id
- The unique identifier of the server.
Result
JSON
{
"addresses" : {
"public" : [
{
"version" : 4,
"addr" : "{ip_address}"
}
],
"private" : [
{
"version" : 4,
"addr" : "{ip_address}"
}
]
},
"links" : [
{
"href" : "http://{api_server}/servers/{server_id}/ips",
"rel": "self"
}
]
}
- 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:
HTTP/1.1 200 OK
Response Body:
{
"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"
}
]
}
Unauthorized access
- GET http(s)://{api_server}/servers/test_server_0013/ips
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 list flexible IPs for a non-existent server
- GET http(s)://{api_server}/servers/{fake_server_id}/ips
Request Headers:
Content-Type:application/json Charset=UTF-8 Authorization:Base64-encoded username & password string
Response Code:
HTTP/1.1 404 Not Found
Response Body:
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": ""
}
}
