PUT /katello/api/host_collections/:id
Update a host collection

Examples

PUT /katello/api/host_collections/992660475
{
  "organization_id": 114267492,
  "unlimited_hosts": false,
  "host_collection": {
    "organization_id": 114267492,
    "unlimited_hosts": false
  }
}
422
{
  "displayMessage": "Validation failed: Max hosts max_hosts must be given a value if this host collection is not unlimited.",
  "errors": {
    "max_hosts": [
      "max_hosts must be given a value if this host collection is not unlimited."
    ]
  }
}

Params

Param name Description
id
required

Id of the host collection

Validations:

  • Must be a number.
name
optional

Host Collection name

Validations:

  • String
description
optional

Validations:

  • String
host_ids
optional

List of host ids to replace the hosts in host collection

Validations:

  • Must be an array of any type
max_hosts
optional

Maximum number of hosts in the host collection

Validations:

  • Integer
unlimited_hosts
optional

Whether or not the host collection may have unlimited hosts

Validations:

  • Must be one of: true, false, 1, 0.