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 |