Examples

POST /api/operatingsystems
{
  "operatingsystem": {
    "name": "awsome_os",
    "major": "1",
    "minor": "2"
  }
}
201
{
  "description": null,
  "major": "1",
  "minor": "2",
  "family": null,
  "release_name": null,
  "password_hash": "SHA256",
  "created_at": "2018-11-16 10:03:00 UTC",
  "updated_at": "2018-11-16 10:03:00 UTC",
  "id": 1073012829,
  "name": "awsome_os",
  "title": "awsome_os 1.2",
  "media": [],
  "architectures": [],
  "ptables": [],
  "config_templates": [],
  "provisioning_templates": [],
  "os_default_templates": [],
  "images": [],
  "parameters": []
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

operatingsystem
required

Validations:

  • Must be a Hash

operatingsystem[name]
required

Validations:

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

operatingsystem[major]
required

Validations:

  • Must be a String

operatingsystem[minor]
optional , nil allowed

Validations:

  • Must be a String

operatingsystem[description]
optional , nil allowed

Validations:

  • Must be a String

operatingsystem[family]
optional , nil allowed

Validations:

  • Must be a String

operatingsystem[release_name]
optional , nil allowed

Validations:

  • Must be a String

operatingsystem[os_parameters_attributes]
optional , nil allowed

Array of parameters

Validations:

  • Must be an Array of nested elements

operatingsystem[os_parameters_attributes][name]
required

Name of the parameter

Validations:

  • Must be a String

operatingsystem[os_parameters_attributes][value]
required

Parameter value

Validations:

  • Must be a String

operatingsystem[password_hash]
optional , nil allowed

Root password hash function to use

Validations:

  • Must be one of: SHA256, SHA512, Base64, Base64-Windows, MD5.

operatingsystem[architecture_ids]
optional , nil allowed

IDs of associated architectures

Validations:

  • Must be an array of any type

operatingsystem[provisioning_template_ids]
optional , nil allowed

IDs of associated provisioning templates

Validations:

  • Must be an array of any type

operatingsystem[medium_ids]
optional , nil allowed

IDs of associated media

Validations:

  • Must be an array of any type

operatingsystem[ptable_ids]
optional , nil allowed

IDs of associated partition tables

Validations:

  • Must be an array of any type