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 , nil allowed

Value: Must be String
operatingsystem[description]
optional , nil allowed

Value: Must be String
operatingsystem[family]
optional , nil allowed

Value: Must be String
operatingsystem[release_name]
optional , nil allowed

Value: Must be String
operatingsystem[password_hash]
optional , nil allowed

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


Value: Must be String
operatingsystem[architecture_ids]
optional , nil allowed

IDs of associated architectures


Value: Must be an array of any type
operatingsystem[config_template_ids]
optional , nil allowed

IDs of associated provisioning templates


Value: Must be an array of any type
operatingsystem[provisioning_template_ids]
optional , nil allowed

IDs of associated provisioning templates


Value: Must be an array of any type
operatingsystem[medium_ids]
optional , nil allowed

IDs of associated media


Value: Must be an array of any type
operatingsystem[ptable_ids]
optional , nil allowed

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 , nil allowed

Value: Must be String
operatingsystem[description]
optional , nil allowed

Value: Must be String
operatingsystem[family]
optional , nil allowed

Value: Must be String
operatingsystem[release_name]
optional , nil allowed

Value: Must be String
operatingsystem[password_hash]
optional , nil allowed

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


Value: Must be String
operatingsystem[architecture_ids]
optional , nil allowed

IDs of associated architectures


Value: Must be an array of any type
operatingsystem[config_template_ids]
optional , nil allowed

IDs of associated provisioning templates


Value: Must be an array of any type
operatingsystem[provisioning_template_ids]
optional , nil allowed

IDs of associated provisioning templates


Value: Must be an array of any type
operatingsystem[medium_ids]
optional , nil allowed

IDs of associated media


Value: Must be an array of any type
operatingsystem[ptable_ids]
optional , nil allowed

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