Thank youHashiConf Europe is a wrap. Watch this year’s sessions on-demand. Watch Now

Boundary Controller HTTP API

Host Set Service

List Host Sets
GET /v1/host-sets
Expand

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.

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[]
attributes object

The attributes that are applicable for the specific Host Set type.

authorized_actions string[]
Create Host Set
POST /v1/host-sets
Expand

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.

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.

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[]
attributes object

The attributes that are applicable for the specific Host Set type.

authorized_actions string[]
Get Host Set
GET /v1/host-sets/{id}
Expand

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.

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[]
attributes object

The attributes that are applicable for the specific Host Set type.

authorized_actions string[]
Delete Host Set
DELETE /v1/host-sets/{id}
Expand

Delete a Host Set.

Request

Path Parameters

id string Required

Response

Successful Response

No content.
Update Host Set
PATCH /v1/host-sets/{id}
Expand

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.

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.

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[]
attributes object

The attributes that are applicable for the specific Host Set type.

authorized_actions string[]
Add Host Set Hosts
POST /v1/host-sets/{id}:add-hosts
Expand

Adds existing Hosts to a Host Set.

Request

Path Parameters

id string Required

Body Parameters

id string
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.

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[]
attributes object

The attributes that are applicable for the specific Host Set type.

authorized_actions string[]
Remove Host Set Hosts
POST /v1/host-sets/{id}:remove-hosts
Expand

Removes Hosts from the Host Set.

Request

Path Parameters

id string Required

Body Parameters

id string
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.

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[]
attributes object

The attributes that are applicable for the specific Host Set type.

authorized_actions string[]
Set Host Set Hosts
POST /v1/host-sets/{id}:set-hosts
Expand

Sets the Hosts on the Host Set.

Request

Path Parameters

id string Required

Body Parameters

id string
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.

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[]
attributes object

The attributes that are applicable for the specific Host Set type.

authorized_actions string[]