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

architecture_id
optional

ID of architecture

Validations:

  • String

medium_id
optional

ID of medium

Validations:

  • String

ptable_id
optional

ID of partition table

Validations:

  • String

provisioning_template_id
optional

ID of template

Validations:

  • String

os_parameters_attributes
optional

Array of parameters

Validations:

  • Must be an Array of nested elements

os_parameters_attributes[name]
required

Name of the parameter

Validations:

  • String

os_parameters_attributes[value]
required

Parameter value

Validations:

  • String

search
optional

filter results

Validations:

  • String

order
optional

Sort field and order, eg. ‘id 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 string
description string
family string
major string
medium string
minor string
name string
params string
template string
title string