Boundary Controller HTTP API
Host Service
List all Hosts for the specified Catalog.
Request
Query Parameters
host_catalog_id
string
filter
string
Response
Successful Response
items
object[]
Host contains all fields related to a Host resource
id
string
Output only. The ID of the Host.
host_catalog_id
string
The Host Catalog of which this Host 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 resource.
host_set_ids
string[]
attributes
object
The attributes that are applicable to the specific Host type.
ip_addresses
string[]
dns_names
string[]
external_id
string
Output only. The external ID of the host, if any.
authorized_actions
string[]
Create a single Host.
Request
Body Parameters
host_catalog_id
string
The Host Catalog of which this Host 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 resource.
attributes
object
The attributes that are applicable to the specific Host type.
Response
Successful Response
id
string
Output only. The ID of the Host.
host_catalog_id
string
The Host Catalog of which this Host 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 resource.
host_set_ids
string[]
attributes
object
The attributes that are applicable to the specific Host type.
ip_addresses
string[]
dns_names
string[]
external_id
string
Output only. The external ID of the host, if any.
authorized_actions
string[]
Gets a single Host.
Request
Path Parameters
id
string
RequiredResponse
Successful Response
id
string
Output only. The ID of the Host.
host_catalog_id
string
The Host Catalog of which this Host 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 resource.
host_set_ids
string[]
attributes
object
The attributes that are applicable to the specific Host type.
ip_addresses
string[]
dns_names
string[]
external_id
string
Output only. The external ID of the host, if any.
authorized_actions
string[]
Delete a Host.
Request
Path Parameters
id
string
RequiredResponse
Successful Response
Update a Host.
Request
Path Parameters
id
string
RequiredQuery Parameters
update_mask
string
Body Parameters
host_catalog_id
string
The Host Catalog of which this Host 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 resource.
attributes
object
The attributes that are applicable to the specific Host type.
Response
Successful Response
id
string
Output only. The ID of the Host.
host_catalog_id
string
The Host Catalog of which this Host 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 resource.
host_set_ids
string[]
attributes
object
The attributes that are applicable to the specific Host type.
ip_addresses
string[]
dns_names
string[]
external_id
string
Output only. The external ID of the host, if any.
authorized_actions
string[]