Boundary controller HTTP API

Host Service

List HostsGET/v1/hosts

List all Hosts for the specified 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.

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

The ID of the scope.

type string

The type of the scope.

name string

The name of the scope, if any.

description string

The description of the scope, if any.

parent_scope_id string

The ID of the parent scope, if any. This field is empty if it 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.

external_name string

Output only. Refers to the name for a given host provided by the plugin enabled backing service.

authorized_actions string[]

response_type string

The type of response, either "delta" or "complete". Delta signifies that this is part of a paginated result or an update to a previously completed pagination. Complete signifies that it is the last page.

list_token string

An opaque token used to continue an existing pagination or request updated items. Use this token in the next list request to request the next page.

sort_by string

The name of the field which the items are sorted by.

sort_dir string

The direction of the sort, either "asc" or "desc".

removed_ids string[]

est_item_count integer

An estimate at the total items available. This may change during pagination.

Create HostPOST/v1/hosts

Create a single Host.

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.

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

The ID of the scope.

type string

The type of the scope.

name string

The name of the scope, if any.

description string

The description of the scope, if any.

parent_scope_id string

The ID of the parent scope, if any. This field is empty if it 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.

external_name string

Output only. Refers to the name for a given host provided by the plugin enabled backing service.

authorized_actions string[]

Get HostGET/v1/hosts/{id}

Gets a single Host.

Path Parameters

id string

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

The ID of the scope.

type string

The type of the scope.

name string

The name of the scope, if any.

description string

The description of the scope, if any.

parent_scope_id string

The ID of the parent scope, if any. This field is empty if it 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.

external_name string

Output only. Refers to the name for a given host provided by the plugin enabled backing service.

authorized_actions string[]

Delete HostDELETE/v1/hosts/{id}

Delete a Host.

Path Parameters

id string

Update HostPATCH/v1/hosts/{id}

Update a Host.

Path Parameters

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

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

The ID of the scope.

type string

The type of the scope.

name string

The name of the scope, if any.

description string

The description of the scope, if any.

parent_scope_id string

The ID of the parent scope, if any. This field is empty if it 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.

external_name string

Output only. Refers to the name for a given host provided by the plugin enabled backing service.

authorized_actions string[]