ServerList

(Difference between revisions)
Jump to: navigation, search
(Created page with "Lists all server. '''GET''' /servers?''name=serverName&status=serverStatus&image=imageRef'' == Parameters == ; name - ''string'' : ''Optional'' Server name to search for. ;...")
 
(JSON)
Line 15: Line 15:
 
== Result ==
 
== Result ==
 
=== JSON ===
 
=== JSON ===
<nowiki>
+
 
 +
<big><source lang="javascript">
 
{
 
{
 
   "servers":[
 
   "servers":[
Line 47: Line 48:
 
   ]
 
   ]
 
}
 
}
</nowiki>
+
</source></big>
 +
 
  
 
; id - ''string''
 
; id - ''string''

Revision as of 16:33, 1 February 2012

Lists all server.

GET /servers?name=serverName&status=serverStatus&image=imageRef

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://127.0.0.1:6543/images/debian_lenny_template/

Result

JSON

{
   "servers":[
      {
         "id":"michalski275226-AUS001-0005",
         "links":[
            {
               "href":"http://127.0.0.1:6543/servers/michalski275226-AUS001-0005/",
               "rel":"self"
            }
         ]
      },
      {
         "id":"michalski275226-AUS001-0001",
         "links":[
            {
               "href":"http://127.0.0.1:6543/servers/michalski275226-AUS001-0001/",
               "rel":"self"
            }
         ]
      },
      {
         "id":"michalski275226-AUS001-0003",
         "links":[
            {
               "href":"http://127.0.0.1:6543/servers/michalski275226-AUS001-0003/",
               "rel":"self"
            }
         ]
      }
   ]
}


id - string
Unique identifier for this server.
links - array
Hypermedia for this resource.


blog comments powered by Disqus


Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox