ImageList

This operation will list all images.

GET /images

Parameters

No parameters

Result

JSON

{
   "images":[
      {
         "name":"{display_image_name}",
         "links":[
            {
               "href":"http://{api_server}/images/{image_id}/",
               "rel":"self"
            },
            {
               "href":"http://{api_server}/images/{image_id}/",
               "rel":"bookmark"
            }
         ],
         "id":"{image_id}"
      },
      {
         "name":"{display_image_name}",
         "links":[
            {
               "href":"http://{api_server}/images/{image_id}/",
               "rel":"self"
            },
            {
               "href":"http://{api_server}/images/{image_id}/",
               "rel":"bookmark"
            }
         ],
         "id":"{image_id}"
      }
   ]
}

id - string

Unique identifier for this image.

links - array

Hypermedia for this resource.

name - string

Display name for this image.

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 images

GET {api_server}/images

Request Headers:

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

Response Code:

HTTP/1.1 200 OK

Response Body:

     {
       "images": [
          {
             "name": "test_public_image", 
             "links": [
                {
                   "href": "http://{api_server}/images/123/", 
                   "rel": "self"
                }, 
                {
                   "href": "http://{api_server}/images/123/", 
                   "rel": "bookmark"
                }
             ], 
             "id": "123"
          }, 
          {
             "name": "test_debian_image", 
             "links": [
                 {
                    "href": "http://{api_server}/images/290/", 
                    "rel": "self"
                 }, 
                 {
                    "href": "http://{api_server}/images/290/", 
                    "rel": "bookmark"
                 }
              ], 
              "id": "290"
          },
          {
              "name": "test_private_image", 
              "links":  [
                  {
                     "href": "http://{api_server}/images/233/", 
                     "rel": "self"
                  },
                  {
                     "href": "http://{api_server}/images/233/", 
                     "rel": "bookmark"
                  }
              ], 
              "id": "233"
           }
       ]
    }

Failure while trying to make an unauthorized request

GET {api_server}/images

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.

blog comments powered by Disqus