GET /api/operatingsystems
List all operating systems

GET /api/architectures/:architecture_id/operatingsystems
List all operating systems for nested architecture

GET /api/media/:medium_id/operatingsystems
List all operating systems for nested medium

GET /api/ptables/:ptable_id/operatingsystems
List all operating systems for nested partition table

GET /api/config_templates/:config_template_id/operatingsystems
List all operating systems for nested provisioning template

GET /api/provisioning_templates/:provisioning_template_id/operatingsystems
List all operating systems for nested provisioning template

Params

Param Name Description
architecture_id
Optional

ID of architecture


Value:

Must be String

medium_id
Optional

ID of medium


Value:

Must be String

ptable_id
Optional

ID of partition table


Value:

Must be String

config_template_id
Optional

ID of template


Value:

Must be String

provisioning_template_id
Optional

ID of template


Value:

Must be String

search
Optional

filter results


Value:

Must be String

order
Optional

sort results


Value:

Must be String

page
Optional

paginate results


Value:

Must be String

per_page
Optional

number of entries per request


Value:

Must be String


GET /api/operatingsystems/:id
Show an operating system

Params

Param Name Description
id
Required

Value:

Must be String


POST /api/operatingsystems
Create an operating system

Params

Param Name Description
operatingsystem
Required

Value:

Must be a Hash

operatingsystem[name]
Required

Value:

Must match regular expression /A(S+)Z/.

operatingsystem[major]
Required

Value:

Must be String

operatingsystem[minor]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be String

operatingsystem[description]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be String

operatingsystem[family]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be String

operatingsystem[release_name]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be String

operatingsystem[os_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

OS' parameters (array or indexed hash)


Value:

Must be an Array of nested elements

operatingsystem[os_parameters_attributes][name]
Required

Name of the parameter


Value:

Must be String

operatingsystem[os_parameters_attributes][value]
Required

Parameter value


Value:

Must be String

operatingsystem[password_hash]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Root password hash function to use, one of MD5, SHA256, SHA512, Base64


Value:

Must be String

operatingsystem[architecture_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

IDs of associated architectures


Value:

Must be an array of any type

operatingsystem[config_template_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

IDs of associated provisioning templates


Value:

Must be an array of any type

operatingsystem[provisioning_template_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

IDs of associated provisioning templates


Value:

Must be an array of any type

operatingsystem[medium_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

IDs of associated media


Value:

Must be an array of any type

operatingsystem[ptable_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

IDs of associated partition tables


Value:

Must be an array of any type


PUT /api/operatingsystems/:id
Update an operating system

Params

Param Name Description
id
Required

Value:

Must be String

operatingsystem
Required

Value:

Must be a Hash

operatingsystem[name]
Optional

Value:

Must match regular expression /A(S+)Z/.

operatingsystem[major]
Optional

Value:

Must be String

operatingsystem[minor]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be String

operatingsystem[description]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be String

operatingsystem[family]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be String

operatingsystem[release_name]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be String

operatingsystem[os_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

OS' parameters (array or indexed hash)


Value:

Must be an Array of nested elements

operatingsystem[os_parameters_attributes][name]
Optional

Name of the parameter


Value:

Must be String

operatingsystem[os_parameters_attributes][value]
Optional

Parameter value


Value:

Must be String

operatingsystem[password_hash]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Root password hash function to use, one of MD5, SHA256, SHA512, Base64


Value:

Must be String

operatingsystem[architecture_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

IDs of associated architectures


Value:

Must be an array of any type

operatingsystem[config_template_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

IDs of associated provisioning templates


Value:

Must be an array of any type

operatingsystem[provisioning_template_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

IDs of associated provisioning templates


Value:

Must be an array of any type

operatingsystem[medium_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

IDs of associated media


Value:

Must be an array of any type

operatingsystem[ptable_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

IDs of associated partition tables


Value:

Must be an array of any type


DELETE /api/operatingsystems/:id
Delete an operating system

Params

Param Name Description
id
Required

Value:

Must be String


GET /api/operatingsystems/:id/bootfiles
List boot files for an operating system

Params

Param Name Description
id
Required

Value:

Must be String

medium
Optional

Value:

Must be String

architecture
Optional

Value:

Must be String