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:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
compute_resource_id
optional

ID of compute resource

Validations:

  • Must be a String
architecture_id
optional

ID of architecture

Validations:

  • Must be a String
operatingsystem_id
optional

ID of operating system

Validations:

  • Must be a String
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return

Validations:

  • Must be a number.

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

Examples

GET /api/compute_resources/980190962/images/980190962
200
{
  "operatingsystem_id": 309172073,
  "operatingsystem_name": "centos 5.3",
  "compute_resource_id": 980190962,
  "compute_resource_name": "bigcompute",
  "architecture_id": 501905019,
  "architecture_name": "x86_64",
  "uuid": "string-of-uuid",
  "username": "root",
  "created_at": "2020-03-11 07:55:22 UTC",
  "updated_at": "2020-03-11 07:55:22 UTC",
  "id": 980190962,
  "name": "centos-1"
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
compute_resource_id
optional

ID of compute resource

Validations:

  • Must be a String
architecture_id
optional

ID of architecture

Validations:

  • Must be a String
operatingsystem_id
optional

ID of operating system

Validations:

  • Must be a String
>>>

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:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
compute_resource_id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
image
required

Validations:

  • Must be a Hash
image[name]
required

Validations:

  • Must be a String
image[username]
required

Validations:

  • Must be a String
image[uuid]
required

Template ID in the compute resource

Validations:

  • Must be a String
image[password]
optional , nil allowed

Validations:

  • Must be a String
image[compute_resource_id]
optional , nil allowed

ID of compute resource

Validations:

  • Must be a String
image[architecture_id]
optional , nil allowed

ID of architecture

Validations:

  • Must be a String
image[operatingsystem_id]
optional , nil allowed

ID of operating system

Validations:

  • Must be a 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

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
compute_resource_id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
image
required

Validations:

  • Must be a Hash
image[name]
optional

Validations:

  • Must be a String
image[username]
optional

Validations:

  • Must be a String
image[uuid]
optional

Template ID in the compute resource

Validations:

  • Must be a String
image[password]
optional , nil allowed

Validations:

  • Must be a String
image[compute_resource_id]
optional , nil allowed

ID of compute resource

Validations:

  • Must be a String
image[architecture_id]
optional , nil allowed

ID of architecture

Validations:

  • Must be a String
image[operatingsystem_id]
optional , nil allowed

ID of operating system

Validations:

  • Must be a 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

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
compute_resource_id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.