Examples

POST /api/operatingsystems
{
  "operatingsystem": {
    "name": "awsome_os",
    "minor": "2"
  }
}
422
{
  "error": {
    "id": null,
    "errors": {
      "major": [
        "is not a number",
        "Operating System version is required"
      ]
    },
    "full_messages": [
      "Major is not a number",
      "Major Operating System version is required"
    ]
  }
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

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, one of MD5, SHA256, SHA512, Base64

Validations:

  • Must be a String

operatingsystem[architecture_ids]
optional , nil allowed

IDs of associated architectures

Validations:

  • Must be an array of any type

operatingsystem[config_template_ids]
optional , nil allowed

IDs of associated provisioning templates

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