Image object

Example JSON representation

{
  "added": "2013-01-01T12:34:56.789Z", 
  "architecture": "i386", 
  "cloudFeatures": {
    "type": "ImageCloudFeatures"
  }, 
  "cloudImageId": "string", 
  "cloudInitInstalled": true, 
  "cloudLocation": "string", 
  "cloudPlatform": "ec2", 
  "deprecated": true, 
  "id": "string", 
  "lastUsed": "2013-01-01T12:34:56.789Z", 
  "name": "string", 
  "os": {
    "id": "string"
  }, 
  "scalrAgentInstalled": true, 
  "scope": "scalr", 
  "size": 1, 
  "source": "Manual", 
  "status": "active", 
  "statusError": "string", 
  "type": "string"
}

Properties

property attributes valid values description filter option
architecture
string
required
create-only
filterable
"i386"
"x86_64"
?architecture=...
cloudImageId
string
required
create-only
filterable
?cloudImageId=...
cloudPlatform
string
required
create-only
filterable
"ec2"
"gce"
"azure"
"cloudstack"
"idcf"
"openstack"
"ocs"
"rackspacenguk"
"rackspacengus"
"hpcloud"
"mirantis"
"vio"
"cisco"
"vmware"

The Cloud Platform this resource resides in.

?cloudPlatform=...
name
string
required
filterable
?name=...
os
OsForeignKey object
required
create-only
filterable
Pass the id of the object you are referencing in:
?os=...
added
string
read-only

Date and time at which this Image was created.

id
string
read-only
filterable
?id=...
lastUsed
string
read-only

Date and time at which this Image was last used.

scope
string
read-only
filterable
"scalr"
"account"
"environment"
"farm"
"farmrole"
"role"
"server"
?scope=...
source
string
read-only
filterable
"Manual"
"BundleTask"

Indicates how this Image was created.

?source=...
status
string
read-only
filterable
"active"
"pending_delete"
"failed"

Current status for this Image. failed means that the deletion failed.

?status=...
statusError
string
read-only

If the Image is in a failed state, this indicates why.

cloudFeatures
ImageCloudFeatures object
create-only
cloudInitInstalled
boolean
create-only
filterable

Whether cloud-init is installed on this Image.

?cloudInitInstalled=...
cloudLocation
string
create-only
filterable

Cloud Location, inside a given Cloud Platform, for this resource. May be null if this resource does not have a specific location. Note: if you would like to filter on this property, you must also filter on cloudPlatform.

?cloudLocation=...
deprecated
boolean
optional
filterable

Whether this Image is deprecated.

?deprecated=...
scalrAgentInstalled
boolean
create-only
filterable

Whether Scalr Agent is installed on this Image.

?scalrAgentInstalled=...
size
integer
create-only

Size of the image in GB. This property is read-only at the Environment scope.

type
string
create-only

(Only used on EC2 currently) Whether this Image is HVM or EBS. At the Environment scope this property is read-only. Property is deprecated and will be removed soon. Use 'cloudFeatures' instead.

Endpoints using this object