Boundary controller HTTP API
Host Set Service
List all Host Sets under the specific Catalog.
Query Parameters
host_catalog_id string filter string You can specify that the filter should only return items that match. Refer to filter expressions for more information.
list_token string An opaque token that Boundary uses to continue an existing iteration or request updated items. If you do not specify a token, pagination starts from the beginning. To learn more about list pagination in Boundary, refer to list pagination.
page_size integer The maximum size of a page in this iteration. If unset, the default page size configured will be used. If the page_size is greater than the default page configured, the page size will be truncated to this number..
Create a Host Set.
Body Parameters
host_catalog_id string The Host Catalog of which this Host Set is a part.
name string Optional name for identification purposes.
description string Optional user-set description for identification purposes.
version integer Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.
type string The type of the Host Set.
preferred_endpoints string[] sync_interval_seconds integer An interger number of seconds indicating the amount of time that should elapse between syncs of the host set. The interval will be applied to the end of the previous sync operation, not the start. Setting to -1 will disable syncing for that host set; setting to zero will cause the set to use Boundary's default. The default may change between releases. May not be valid for all plugin types.
attributes object The attributes that are applicable for the specific Host Set type.
Get a single Host Set.
Path Parameters
id string RequiredDelete a Host Set.
Path Parameters
id string RequiredUpdate a Host Set.
Path Parameters
id string RequiredBody Parameters
host_catalog_id string The Host Catalog of which this Host Set is a part.
name string Optional name for identification purposes.
description string Optional user-set description for identification purposes.
version integer Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.
type string The type of the Host Set.
preferred_endpoints string[] sync_interval_seconds integer An interger number of seconds indicating the amount of time that should elapse between syncs of the host set. The interval will be applied to the end of the previous sync operation, not the start. Setting to -1 will disable syncing for that host set; setting to zero will cause the set to use Boundary's default. The default may change between releases. May not be valid for all plugin types.
attributes object The attributes that are applicable for the specific Host Set type.
Adds existing Hosts to a Host Set.
Path Parameters
id string RequiredBody Parameters
version integer Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.
host_ids string[] Removes Hosts from the Host Set.
Path Parameters
id string RequiredBody Parameters
version integer Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.
host_ids string[] Sets the Hosts on the Host Set.
Path Parameters
id string RequiredBody Parameters
version integer Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.
host_ids string[]