PUT /api/operatingsystems/:id
Update an operating system

Examples

PUT /api/operatingsystems/1073012838
{
  "operatingsystem": {
    "os_parameters_attributes": [
      {
        "name": "foo",
        "value": "new_value"
      }
    ]
  }
}
200
{
  "description": null,
  "major": "404",
  "minor": "",
  "family": null,
  "release_name": null,
  "password_hash": "SHA256",
  "created_at": "2021-11-26 08:51:17 UTC",
  "updated_at": "2021-11-26 08:51:17 UTC",
  "id": 1073012838,
  "name": "operatingsystem398",
  "title": "operatingsystem398 404",
  "media": [],
  "architectures": [],
  "ptables": [],
  "provisioning_templates": [
    {
      "id": 508279162,
      "name": "Linux host initial configuration",
      "template_kind_id": 508279162,
      "template_kind_name": "host_init_config"
    }
  ],
  "os_default_templates": [
    {
      "id": 1018350805,
      "provisioning_template_id": 508279162,
      "provisioning_template_name": "Linux host initial configuration",
      "template_kind_id": 508279162,
      "template_kind_name": "host_init_config",
      "operatingsystem_id": 1073012838,
      "operatingsystem_name": "operatingsystem398 404"
    }
  ],
  "images": [],
  "parameters": [
    {
      "priority": 50,
      "created_at": "2021-11-26 08:51:17 UTC",
      "updated_at": "2021-11-26 08:51:17 UTC",
      "id": 767575244,
      "name": "foo",
      "parameter_type": "string",
      "value": "new_value"
    }
  ]
}

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
id
required

Validations:

  • Must be a 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 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]
optional

Name of the parameter

Validations:

  • Must be a String
operatingsystem[os_parameters_attributes][value]
optional

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