GET /katello/api/host_collections/992660475 200 { "host_ids": [ 980190962 ], "name": "Simple Host Collection", "organization_id": 114267492, "max_hosts": null, "description": "The simplest of host collections.", "total_hosts": 1, "unlimited_hosts": true, "created_at": "2024-02-22 18:22:29 UTC", "updated_at": "2024-02-22 18:22:29 UTC", "id": 992660475, "permissions": { "deletable": true, "editable": true } }
Param name | Description |
---|---|
id
required |
Id of the host collection Validations:
|
organization_id
optional |
organization identifier Validations:
|
GET /katello/api/host_collections 200 { "total": 5, "subtotal": 5, "selectable": 5, "page": 1, "per_page": 20, "error": null, "search": null, "sort": { "by": "name", "order": "asc" }, "results": [ { "name": "Another Simple Host Collection", "organization_id": 114267492, "max_hosts": null, "description": "Another collection,keeping it simple.", "total_hosts": 0, "unlimited_hosts": true, "created_at": "2024-02-22 18:22:29 UTC", "updated_at": "2024-02-22 18:22:29 UTC", "id": 1031461452, "permissions": { "deletable": true, "editable": true } }, { "name": "Five Host Collection", "organization_id": 114267492, "max_hosts": 5, "description": "A collection of five hosts", "total_hosts": 1, "unlimited_hosts": false, "created_at": "2024-02-22 18:22:29 UTC", "updated_at": "2024-02-22 18:22:29 UTC", "id": 822851436, "permissions": { "deletable": true, "editable": true } }, { "name": "Simple Host Collection", "organization_id": 114267492, "max_hosts": null, "description": "The simplest of host collections.", "total_hosts": 1, "unlimited_hosts": true, "created_at": "2024-02-22 18:22:29 UTC", "updated_at": "2024-02-22 18:22:29 UTC", "id": 992660475, "permissions": { "deletable": true, "editable": true } }, { "name": "Single-host Collection", "organization_id": 114267492, "max_hosts": 1, "description": "A collection of one host", "total_hosts": 0, "unlimited_hosts": false, "created_at": "2024-02-22 18:22:29 UTC", "updated_at": "2024-02-22 18:22:29 UTC", "id": 944981076, "permissions": { "deletable": true, "editable": true } }, { "name": "Yet Another Host Collection", "organization_id": 114267492, "max_hosts": null, "description": "Here we are in a collection again!", "total_hosts": 0, "unlimited_hosts": true, "created_at": "2024-02-22 18:22:29 UTC", "updated_at": "2024-02-22 18:22:29 UTC", "id": 230792737, "permissions": { "deletable": true, "editable": true } } ] }
Param name | Description |
---|---|
search
optional |
Search string Validations:
|
page
optional |
Page number, starting at 1 Validations:
|
per_page
optional |
Number of results per page to return Validations:
|
order
optional |
Sort field and order, eg. 'id DESC' Validations:
|
full_result
optional |
Whether or not to show all results Validations:
|
sort_by
optional |
Field to sort the results on Validations:
|
sort_order
optional |
How to order the sorted results (e.g. ASC for ascending) Validations:
|
organization_id
optional |
organization identifier Validations:
|
name
optional |
host collection name to filter by Validations:
|
activation_key_id
optional |
activation key identifier Validations:
|
host_id
optional |
Filter products by host id Validations:
|
available_for
optional |
Interpret specified object to return only Host Collections that can be associated with specified object. The value 'host' is supported. Validations:
|
Field name | Type | Possible values |
---|---|---|
host | string | |
name | string | |
organization_id | integer |
POST /katello/api/organizations/114267492/host_collections { "name": "Collection A", "description": "Collection A, World Cup 2014", "host_ids": [ 980190992 ], "unlimited_hosts": true, "host_collection": { "name": "Collection A", "description": "Collection A, World Cup 2014", "unlimited_hosts": true, "host_ids": [ 980190992 ] } } 201 { "host_ids": [ 980190992 ], "name": "Collection A", "organization_id": 114267492, "max_hosts": null, "description": "Collection A, World Cup 2014", "total_hosts": 1, "unlimited_hosts": true, "created_at": "2024-02-22 18:24:04 UTC", "updated_at": "2024-02-22 18:24:04 UTC", "id": 1031461453, "permissions": { "deletable": true, "editable": true } }
Param name | Description |
---|---|
organization_id
required |
organization identifier Validations:
|
name
required |
Host Collection name Validations:
|
description
optional |
Validations:
|
host_ids
optional |
List of host ids to replace the hosts in host collection Validations:
|
max_hosts
optional |
Maximum number of hosts in the host collection Validations:
|
unlimited_hosts
optional |
Whether or not the host collection may have unlimited hosts Validations:
|
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 } }
Param name | Description |
---|---|
id
required |
Id of the host collection Validations:
|
name
optional |
Host Collection name Validations:
|
description
optional |
Validations:
|
host_ids
optional |
List of host ids to replace the hosts in host collection Validations:
|
max_hosts
optional |
Maximum number of hosts in the host collection Validations:
|
unlimited_hosts
optional |
Whether or not the host collection may have unlimited hosts Validations:
|
PUT /katello/api/host_collections/992660475/add_hosts { "host_ids": [ 980190962 ], "host_collection": { "host_ids": [ 980190962 ] } } 200 { "displayMessages": { "success": [], "error": [ "Host with ID 980190962 already exists in the host collection." ] } }
Param name | Description |
---|---|
id
required |
Id of the host collection Validations:
|
host_ids
optional |
Array of host ids Validations:
|
PUT /katello/api/host_collections/992660475/remove_hosts { "host_ids": [ 980190962 ], "host_collection": { "host_ids": [ 980190962 ] } } 200 { "displayMessages": { "success": [ "Successfully removed 1 Host(s)." ], "error": [] } }
Param name | Description |
---|---|
id
required |
Id of the host collection Validations:
|
host_ids
optional |
Array of host ids Validations:
|
DELETE /katello/api/host_collections/992660475 { "host_collection": {} } 200 { "host_ids": [], "name": "Simple Host Collection", "organization_id": 114267492, "max_hosts": null, "description": "The simplest of host collections.", "total_hosts": 0, "unlimited_hosts": true, "created_at": "2024-02-22 18:22:29 UTC", "updated_at": "2024-02-22 18:22:29 UTC", "id": 992660475, "permissions": { "deletable": true, "editable": true } }
Param name | Description |
---|---|
id
required |
Id of the host collection Validations:
|
Param name | Description |
---|---|
id
required |
ID of the host collection Validations:
|
name
required |
New host collection name Validations:
|