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

Examples

GET /api/compute_resources/980190962/images
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "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": "2022-03-29 09:16:41 UTC",
      "updated_at": "2022-03-29 09:16:41 UTC",
      "id": 980190962,
      "name": "centos-1"
    },
    {
      "operatingsystem_id": 309172073,
      "operatingsystem_name": "centos 5.3",
      "compute_resource_id": 980190962,
      "compute_resource_name": "bigcompute",
      "architecture_id": 501905019,
      "architecture_name": "x86_64",
      "uuid": "MyString2",
      "username": "MyString",
      "created_at": "2022-03-29 09:16:41 UTC",
      "updated_at": "2022-03-29 09:16:41 UTC",
      "id": 298486374,
      "name": "centos-2"
    }
  ]
}

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 number.
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort and order by a searchable field, e.g. ‘

Maruku could not parse this XML/HTML: 
<field> 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, ‘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

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": "2022-03-29 09:16:41 UTC",
  "updated_at": "2022-03-29 09:16:41 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 number.
>>>

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

Examples

POST /api/compute_resources/980190962/images
{
  "image": {
    "name": "TestImage",
    "username": "ec2-user",
    "uuid": "abcdef",
    "password": "password",
    "operatingsystem_id": 309172073,
    "compute_resource_id": 928692541,
    "architecture_id": 331892513,
    "user_data": true
  }
}
201
{
  "operatingsystem_id": 309172073,
  "operatingsystem_name": "centos 5.3",
  "compute_resource_id": 980190962,
  "compute_resource_name": "bigcompute",
  "architecture_id": 331892513,
  "architecture_name": "sparc",
  "uuid": "abcdef",
  "username": "ec2-user",
  "created_at": "2022-03-29 09:16:42 UTC",
  "updated_at": "2022-03-29 09:16:42 UTC",
  "id": 980190963,
  "name": "TestImage"
}

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

Examples

PUT /api/compute_resources/980190962/images/980190962
{
  "image": {}
}
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": "2022-03-29 09:16:41 UTC",
  "updated_at": "2022-03-29 09:16:41 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
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 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

Examples

DELETE /api/compute_resources/980190962/images/980190962
{
  "image": {}
}
200
{
  "id": 980190962,
  "operatingsystem_id": 309172073,
  "compute_resource_id": 980190962,
  "architecture_id": 501905019,
  "uuid": "string-of-uuid",
  "username": "root",
  "name": "centos-1",
  "created_at": "2022-03-29T09:16:41.666Z",
  "updated_at": "2022-03-29T09:16:41.666Z",
  "iam_role": null,
  "user_data": false,
  "password": null
}

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.