POST /katello/api/host_collections
Create a host collection

POST /katello/api/organizations/:organization_id/host_collections
Create a host collection

Examples

POST /katello/api/organizations/114267492-Empty%20Organization/host_collections
{
  "host_collection": {
    "name": "Collection A",
    "description": "Collection A, World Cup 2014"
  }
}
201
{
  "host_ids": [],
  "name": "Collection A",
  "organization_id": 114267492,
  "max_hosts": null,
  "description": "Collection A, World Cup 2014",
  "total_hosts": 0,
  "unlimited_hosts": true,
  "created_at": "2023-08-23 20:04:28 UTC",
  "updated_at": "2023-08-23 20:04:28 UTC",
  "id": 1031461454,
  "permissions": {
    "deletable": true,
    "editable": true
  }
}

Params

Param name Description
organization_id
required

organization identifier

Validations:

  • Must be a number.
name
required

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.