ServerList
(Difference between revisions)
Mike.robski (Talk | contribs) |
Mike.robski (Talk | contribs) |
||
| Line 1: | Line 1: | ||
| + | =='''GET''' /servers?''name=serverName&status=serverStatus&image=imageRef''== | ||
This operation returns a list of all [[Server|servers]]. | This operation returns a list of all [[Server|servers]]. | ||
| − | = | + | === Parameters === |
| − | + | ||
| − | + | ||
; name - ''string'' | ; name - ''string'' | ||
: ''Optional'' Server name to search for. | : ''Optional'' Server name to search for. | ||
| Line 13: | Line 12: | ||
: ''Optional'' Absolute URL of the image to filter servers by. ''e.g. http(s)://{api_server}/images/{image_id}/'' | : ''Optional'' Absolute URL of the image to filter servers by. ''e.g. http(s)://{api_server}/images/{image_id}/'' | ||
| − | == Result == | + | === Result === |
| − | === JSON === | + | ==== JSON ==== |
<nowiki> | <nowiki> | ||
{ | { | ||
| Line 45: | Line 44: | ||
: [[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 52: | Line 51: | ||
:''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. | ||
| − | == Examples == | + | === Examples === |
'''Successfully list servers''' | '''Successfully list servers''' | ||
:'''GET''' http(s)://{api_server}/servers | :'''GET''' http(s)://{api_server}/servers | ||
| Line 117: | Line 116: | ||
does not understand how to supply the credentials required. | does not understand how to supply the credentials required. | ||
| − | + | [[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:47, 14 December 2012
Contents |
GET /servers?name=serverName&status=serverStatus&image=imageRef
This operation returns a list of all servers.
Parameters
- name - string
- Optional Server name to search for.
- status - string
- Optional Server status to search for. Values: BUILD, ACTIVE, SUSPENDED, DELETED, UNKNOWN
- image - string
- Optional Absolute URL of the image to filter servers by. e.g. http(s)://{api_server}/images/{image_id}/
Result
JSON
{
"servers":[
{
"id":"{server_id}",
"links":[
{
"href":"http://{api_server}/servers/{server_id}/",
"rel":"self"
}
]
},
{
"id":"{server_id}",
"links":[
{
"href":"http://{api_server}/servers/{server_id}/",
"rel":"self"
}
]
}
]
}
- id - string
- Unique identifier for this server.
- 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 the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
Examples
Successfully list servers
- GET http(s)://{api_server}/servers
Request Headers:
Content-Type:application/json Charset=UTF-8 Authorization:Base64-encoded username & password string
Response Code:
HTTP/1.1 200 OK
Response Body:
{
"servers" : [
{
"id": "test_server_0001",
"links": [
{
"href": "http://{api_server}/servers/test_server_0001/",
"rel": "self"
}
]
},
{
"id": "test_server_0013",
"links": [
{
"href": "http://{api_server}/servers/test_server_0013/",
"rel": "self"
}
]
},
{
"id": "test_server_0015",
"links": [
{
"href": "http://{api_server}/servers/test_server_0015/",
"rel": "self"
}
]
}
]
}
Failure while trying to make unauthorized access
- GET http://{api_server}/servers
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.
