Api Documentation

>>>

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: Must be a Integer
organization_id Optional	Scope by organizations 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	paginate results Validations: Must be a String
per_page Optional	number of entries per request Validations: Must be a String

Search fields

Field name	Tipo	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: Must be a Integer
organization_id Optional	Scope by organizations 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	Scope by locations Validations: Must be a Integer
organization_id Optional	Scope by organizations 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	Validations: Must be a String
image[password] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>	Validations: Must be a String
image[compute_resource_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>	ID of compute resource Validations: Must be a String
image[architecture_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>	ID of architecture Validations: Must be a String
image[operatingsystem_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>	ID of operating system Validations: Must be a String
image[user_data] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>	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: Must be a Integer
organization_id Optional	Scope by organizations 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	Validations: Must be a String
image[password] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>	Validations: Must be a String
image[compute_resource_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>	ID of compute resource Validations: Must be a String
image[architecture_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>	ID of architecture Validations: Must be a String
image[operatingsystem_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>	ID of operating system Validations: Must be a String
image[user_data] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>	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: Must be a Integer
organization_id Optional	Scope by organizations 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.