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

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

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:

  • String

search
optional

filter results

Validations:

  • String

order
optional

sort results

Validations:

  • String

page
optional

paginate results

Validations:

  • String

per_page
optional

number of entries per request

Validations:

  • String

Search fields

Field name Type Possible values
architecture integer
compute_resource string
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

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

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:

  • String


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

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

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

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:

  • String

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

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

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

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:

  • String

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

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

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