ServerList

Revision as of 18:59, 12 April 2013

This operation returns a list of all servers.

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(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.