GET /katello/api/host_collections/:id
Show a host collection

Params

Param name Description
id
required

Id of the host collection

Validations:

  • number.


GET /katello/api/host_collections
List host collections

GET /katello/api/organizations/:organization_id/host_collections
List host collections within an organization

GET /katello/api/activation_keys/:activation_key_id/host_collections
List host collections in an activation key

Params

Param name Description
search
optional

Search string

Validations:

  • String

page
optional

Page number, starting at 1

Validations:

  • number.

per_page
optional

Number of results per page to return

Validations:

  • number.

order
optional

Sort field and order, eg. ‘name DESC’

Validations:

  • String

full_result
optional

Whether or not to show all results

Validations:

  • boolean

sort
optional

Hash version of ‘order’ param

Validations:

  • Hash

sort[by]
optional

Field to sort the results on

Validations:

  • String

sort[order]
optional

How to order the sorted results (e.g. ASC for ascending)

Validations:

  • String

organization_id
optional

organization identifier

Validations:

  • number.

name
optional

host collection name to filter by

Validations:

  • String

activation_key_id
optional

activation key identifier

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

host_id
optional

Filter products by host id

Validations:

  • number.

available_for
optional

Interpret specified object to return only Host Collections that can be associated with specified object. The value ‘host’ is supported.

Validations:

  • String


POST /katello/api/host_collections
Create a host collection

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

Params

Param name Description
organization_id
required

organization identifier

Validations:

  • 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:

  • boolean


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

Params

Param name Description
id
required

Id of the host collection

Validations:

  • 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:

  • boolean


PUT /katello/api/host_collections/:id/add_hosts
Add host to the host collection

Params

Param name Description
id
required

Id of the host collection

Validations:

  • number.

host_ids
optional

Array of host ids

Validations:

  • Must be an array of any type


PUT /katello/api/host_collections/:id/remove_hosts
Remove hosts from the host collection

Params

Param name Description
id
required

Id of the host collection

Validations:

  • number.

host_ids
optional

Array of host ids

Validations:

  • Must be an array of any type


DELETE /katello/api/host_collections/:id
Destroy a host collection

Params

Param name Description
id
required

Id of the host collection

Validations:

  • number.


POST /katello/api/host_collections/:id/copy
Make copy of a host collection

Params

Param name Description
id
required

ID of the host collection

Validations:

  • number.

name
required

New host collection name

Validations:

  • String