GET /api/operatingsystems
List all operating systems.

Params

Param name Description
search
optional

filter results

Validations:

  • Must be String

order
optional

sort results

Validations:

  • Must be String

page
optional

paginate results

Validations:

  • Must be String

per_page
optional

number of entries per request

Validations:

  • Must be String


GET /api/operatingsystems/:id
Show an OS.

Params

Param name Description
id
required

Validations:

  • Must be String


POST /api/operatingsystems
Create an OS.

Params

Param name Description
operatingsystem
required

Validations:

  • Must be a Hash

operatingsystem[name]
required

Validations:

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

operatingsystem[major]
required

Validations:

  • Must be String

operatingsystem[minor]
optional

Validations:

  • Must be String

operatingsystem[description]
optional

Validations:

  • Must be String

operatingsystem[family]
optional

Validations:

  • Must be String

operatingsystem[release_name]
optional

Validations:

  • Must be String

operatingsystem[password_hash]
optional

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

Validations:

  • Must be String

operatingsystem[config_template_ids]
optional

IDs of associated provisioning templates

Validations:

  • Must be an array of any type

operatingsystem[provisioning_template_ids]
optional

IDs of associated provisioning templates

Validations:

  • Must be an array of any type


PUT /api/operatingsystems/:id
Update an OS.

Params

Param name Description
id
required

Validations:

  • Must be String

operatingsystem
required

Validations:

  • Must be a Hash

operatingsystem[name]
optional

Validations:

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

operatingsystem[major]
optional

Validations:

  • Must be String

operatingsystem[minor]
optional

Validations:

  • Must be String

operatingsystem[description]
optional

Validations:

  • Must be String

operatingsystem[family]
optional

Validations:

  • Must be String

operatingsystem[release_name]
optional

Validations:

  • Must be String

operatingsystem[password_hash]
optional

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

Validations:

  • Must be String

operatingsystem[config_template_ids]
optional

IDs of associated provisioning templates

Validations:

  • Must be an array of any type

operatingsystem[provisioning_template_ids]
optional

IDs of associated provisioning templates

Validations:

  • Must be an array of any type


DELETE /api/operatingsystems/:id
Delete an OS.

Params

Param name Description
id
required

Validations:

  • Must be String


GET /api/operatingsystems/:id/bootfiles
List boot files an OS.

Params

Param name Description
id
required

Validations:

  • Must be String

medium
optional

Validations:

  • Must be String

architecture
optional

Validations:

  • Must be String