Examples

PUT /katello/api/host_collections/992660475
{
  "organization_id": 114267492,
  "max_hosts": 0,
  "unlimited_hosts": false,
  "host_collection": {
    "max_hosts": 0,
    "organization_id": 114267492,
    "unlimited_hosts": false
  }
}
422
{
  "displayMessage": "Validation failed: Max hosts must be a positive integer value., Max host may not be less than the number of hosts associated with the host collection.",
  "errors": {
    "max_hosts": [
      "must be a positive integer value."
    ],
    "max_host": [
      "may not be less than the number of hosts associated with the host collection."
    ]
  }
}

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.