Cloud Management API 1.5

Images

Images represent base VM image existing in a cloud. An image will define the initial Operating System and root disk contents for a new Instance to have, and therefore it represents the basic starting point for creating a new one.

Actions

index

Lists all Images for the given Cloud.

URLs
GET /api/clouds/:cloud_id/images
HTTP response code
200 OK
Content-type
application/vnd.rightscale.image;type=collection

Required roles

Parameters

name required type values regexp blank? description
filter no Array * * no See below for valid filter parameters.
view no String default * no Specifies how many attributes and/or expanded nested relationships to include.

Filters

name partial_match? description
cpu_architecture yes The CPU architecture of the Instance Type to filter on. Examples: x86 or 64-bit architecture.
description yes Description of the Image to filter on.
image_type no The Image Type to filter on. This will be either "machine", "machine_azure", "ramdisk" or "kernel".
name yes Name of the Image to filter on.
os_platform yes The image's operating system to filter on. Examples: Linux or Windows.
resource_uid no Resource Unique IDentifier for the Image to filter on.
visibility no The visibility of the Image in the cloud to filter on. Examples: private, public.

Example Responses

Click on a format below to see an example response:

JSON XML
[{
  "resource_uid": "resource_machine_4185118448",
  "name": "NAME_2379123432",
  "description": null,
  "os_platform": null,
  "image_type": "machine",
  "visibility": "private",
  "virtualization_type": null,
  "cpu_architecture": null,
  "links": [
    {"rel":"self","href":"/api/clouds/888/images/RS_ID_1206730659"},
    {"rel":"cloud","href":"/api/clouds/888"}
  ],
  "actions": [

  ]
},{
  "resource_uid": "resource_machine_3300696784",
  "name": "NAME_3199801525",
  "description": null,
  "os_platform": null,
  "image_type": "machine",
  "visibility": "private",
  "virtualization_type": null,
  "cpu_architecture": null,
  "links": [
    {"rel":"self","href":"/api/clouds/888/images/RS_ID_1144856963"},
    {"rel":"cloud","href":"/api/clouds/888"}
  ],
  "actions": [

  ]
}]
<?xml version="1.0" encoding="UTF-8"?>
<images>
  <image>
    <resource_uid>resource_machine_4185118448</resource_uid>
    <name>NAME_2379123432</name>
    <description/>
    <os_platform/>
    <image_type>machine</image_type>
    <visibility>private</visibility>
    <virtualization_type/>
    <cpu_architecture/>
    <links>
      <link rel="self" href="/api/clouds/888/images/RS_ID_1206730659"/>
      <link rel="cloud" href="/api/clouds/888"/>
    </links>
    <actions/>
  </image>
  <image>
    <resource_uid>resource_machine_3300696784</resource_uid>
    <name>NAME_3199801525</name>
    <description/>
    <os_platform/>
    <image_type>machine</image_type>
    <visibility>private</visibility>
    <virtualization_type/>
    <cpu_architecture/>
    <links>
      <link rel="self" href="/api/clouds/888/images/RS_ID_1144856963"/>
      <link rel="cloud" href="/api/clouds/888"/>
    </links>
    <actions/>
  </image>
</images>

show

Shows information about a single Image.

URLs
GET /api/clouds/:cloud_id/images/:id
HTTP response code
200 OK
Content-type
application/vnd.rightscale.image

Required roles

Parameters

name required type values regexp blank? description
view no String default * no Specifies how many attributes and/or expanded nested relationships to include.

Example Responses

Click on a format below to see an example response:

JSON XML
{
  "resource_uid": "resource_machine_4185118448",
  "name": "NAME_2379123432",
  "description": null,
  "os_platform": null,
  "image_type": "machine",
  "visibility": "private",
  "virtualization_type": null,
  "cpu_architecture": null,
  "links": [
    {"rel":"self","href":"/api/clouds/888/images/RS_ID_1206730659"},
    {"rel":"cloud","href":"/api/clouds/888"}
  ],
  "actions": [

  ]
}
<?xml version="1.0" encoding="UTF-8"?>
<image>
  <resource_uid>resource_machine_4185118448</resource_uid>
  <name>NAME_2379123432</name>
  <description/>
  <os_platform/>
  <image_type>machine</image_type>
  <visibility>private</visibility>
  <virtualization_type/>
  <cpu_architecture/>
  <links>
    <link rel="self" href="/api/clouds/888/images/RS_ID_1206730659"/>
    <link rel="cloud" href="/api/clouds/888"/>
  </links>
  <actions/>
</image>