Images

>>>

GET /api/compute_resources/:compute_resource_id/images
List all images for a compute resource

GET /api/operatingsystems/:operatingsystem_id/images
List all images for operating system

GET /api/architectures/:architecture_id/images
List all images for architecture

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
compute_resource_id
optional

ID of compute resource

Validations:

  • String
architecture_id
optional

ID of architecture

Validations:

  • String
operatingsystem_id
optional

ID of operating system

Validations:

  • Must be a number.
search
optional

filter results

Validations:

  • String
order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.

Search fields

Field name Type Possible values
architecture integer
compute_resource string
id integer
name string
operatingsystem integer
user_data true, false
username string
>>>

GET /api/compute_resources/:compute_resource_id/images/:id
Show an image

GET /api/operatingsystems/:operatingsystem_id/images/:id
Show an image

GET /api/architectures/:architecture_id/images/:id
Show an image

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
compute_resource_id
optional

ID of compute resource

Validations:

  • String
architecture_id
optional

ID of architecture

Validations:

  • String
operatingsystem_id
optional

ID of operating system

Validations:

  • Must be a number.
>>>

POST /api/compute_resources/:compute_resource_id/images
Create an image

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
compute_resource_id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
image
required

Validations:

  • Hash
image[name]
required

Validations:

  • String
image[username]
required

Validations:

  • String
image[uuid]
required

Template ID in the compute resource

Validations:

  • String
image[password]
optional , nil allowed

Validations:

  • String
image[compute_resource_id]
optional , nil allowed

ID of compute resource

Validations:

  • String
image[architecture_id]
optional , nil allowed

ID of architecture

Validations:

  • String
image[operatingsystem_id]
optional , nil allowed

ID of operating system

Validations:

  • Must be a number.
image[user_data]
optional , nil allowed

Whether or not the image supports user data

Validations:

  • Must be one of: true, false, 1, 0.
>>>

PUT /api/compute_resources/:compute_resource_id/images/:id
Update an image

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
compute_resource_id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
image
required

Validations:

  • Hash
image[name]
optional

Validations:

  • String
image[username]
optional

Validations:

  • String
image[uuid]
optional

Template ID in the compute resource

Validations:

  • String
image[password]
optional , nil allowed

Validations:

  • String
image[compute_resource_id]
optional , nil allowed

ID of compute resource

Validations:

  • String
image[architecture_id]
optional , nil allowed

ID of architecture

Validations:

  • String
image[operatingsystem_id]
optional , nil allowed

ID of operating system

Validations:

  • Must be a number.
image[user_data]
optional , nil allowed

Whether or not the image supports user data

Validations:

  • Must be one of: true, false, 1, 0.
>>>

DELETE /api/compute_resources/:compute_resource_id/images/:id
Delete an image

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
compute_resource_id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..