Operating systems

>>>

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