Host Set Service

List all Host Sets under the specific Catalog.

Request

Query Parameters

host_catalog_id string

filter string

Response

Successful Response

items object[]

HostSet is a collection of Hosts created and managed by a Host Catalog

id string

Output only. The ID of the Host Set.

host_catalog_id string

The Host Catalog of which this Host Set is a part.

scope object

Output only. Scope information for this resource.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

plugin object

Output only. Plugin information for this resource.

id string

Output only. The ID of the Plugin.

name string

Output only. The name of the plugin resource in boundary, if any.

description string

Output only. The description of the plugin in boundary, if any.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

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.

host_ids string[]

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.

authorized_actions string[]

Create a Host Set.

Request

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.

Response

Successful Response

id string

Output only. The ID of the Host Set.

host_catalog_id string

The Host Catalog of which this Host Set is a part.

scope object

Output only. Scope information for this resource.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

plugin object

Output only. Plugin information for this resource.

id string

Output only. The ID of the Plugin.

name string

Output only. The name of the plugin resource in boundary, if any.

description string

Output only. The description of the plugin in boundary, if any.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

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.

host_ids string[]

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.

authorized_actions string[]

Get a single Host Set.

Request

Path Parameters

id string Required

Response

Successful Response

id string

Output only. The ID of the Host Set.

host_catalog_id string

The Host Catalog of which this Host Set is a part.

scope object

Output only. Scope information for this resource.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

plugin object

Output only. Plugin information for this resource.

id string

Output only. The ID of the Plugin.

name string

Output only. The name of the plugin resource in boundary, if any.

description string

Output only. The description of the plugin in boundary, if any.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

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.

host_ids string[]

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.

authorized_actions string[]

Delete a Host Set.

Request

Path Parameters

id string Required

Response

Successful Response

No content.

Update a Host Set.

Request

Path Parameters

id string Required

Query Parameters

update_mask string

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.

Response

Successful Response

id string

Output only. The ID of the Host Set.

host_catalog_id string

The Host Catalog of which this Host Set is a part.

scope object

Output only. Scope information for this resource.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

plugin object

Output only. Plugin information for this resource.

id string

Output only. The ID of the Plugin.

name string

Output only. The name of the plugin resource in boundary, if any.

description string

Output only. The description of the plugin in boundary, if any.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

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.

host_ids string[]

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.

authorized_actions string[]

Adds existing Hosts to a Host Set.

Request

Path Parameters

id string Required

Body 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[]

Response

Successful Response

id string

Output only. The ID of the Host Set.

host_catalog_id string

The Host Catalog of which this Host Set is a part.

scope object

Output only. Scope information for this resource.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

plugin object

Output only. Plugin information for this resource.

id string

Output only. The ID of the Plugin.

name string

Output only. The name of the plugin resource in boundary, if any.

description string

Output only. The description of the plugin in boundary, if any.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

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.

host_ids string[]

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.

authorized_actions string[]

Removes Hosts from the Host Set.

Request

Path Parameters

id string Required

Body 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[]

Response

Successful Response

id string

Output only. The ID of the Host Set.

host_catalog_id string

The Host Catalog of which this Host Set is a part.

scope object

Output only. Scope information for this resource.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

plugin object

Output only. Plugin information for this resource.

id string

Output only. The ID of the Plugin.

name string

Output only. The name of the plugin resource in boundary, if any.

description string

Output only. The description of the plugin in boundary, if any.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

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.

host_ids string[]

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.

authorized_actions string[]

Sets the Hosts on the Host Set.

Request

Path Parameters

id string Required

Body 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[]

Response

Successful Response

id string

Output only. The ID of the Host Set.

host_catalog_id string

The Host Catalog of which this Host Set is a part.

scope object

Output only. Scope information for this resource.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

plugin object

Output only. Plugin information for this resource.

id string

Output only. The ID of the Plugin.

name string

Output only. The name of the plugin resource in boundary, if any.

description string

Output only. The description of the plugin in boundary, if any.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

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.

host_ids string[]

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.

authorized_actions string[]