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

Examples

PUT /katello/api/host_collections/992660475
{
  "organization_id": 114267492,
  "max_hosts": 2,
  "unlimited_hosts": false,
  "host_ids": [
    980190990,
    298486374
  ],
  "host_collection": {
    "max_hosts": 2,
    "organization_id": 114267492,
    "unlimited_hosts": false,
    "host_ids": [
      980190990,
      298486374
    ]
  }
}
200
{
  "host_ids": [
    980190990,
    298486374
  ],
  "name": "Simple Host Collection",
  "organization_id": 114267492,
  "max_hosts": 2,
  "description": "The simplest of host collections.",
  "total_hosts": 2,
  "unlimited_hosts": false,
  "created_at": "2024-02-22 18:22:29 UTC",
  "updated_at": "2024-02-22 18:24:04 UTC",
  "id": 992660475,
  "permissions": {
    "deletable": true,
    "editable": true
  }
}

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.