Param Name | Description |
---|---|
id Required |
Id of the host collection Validations:
|
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. 'name DESC' Validations:
|
full_results Optional |
Whether or not to show all results Validations:
|
sort Optional |
Hash version of 'order' param 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:
|
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:
|
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:
|
Param Name | Description |
---|---|
id Required |
Id of the host collection Validations:
|
host_ids Optional |
Array of host ids Validations:
|
Param Name | Description |
---|---|
id Required |
Id of the host collection Validations:
|
host_ids Optional |
Array of host ids Validations:
|
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:
|