Boundary controller HTTP API

Host Catalog Service

List Host CatalogsGET/v1/host-catalogs

Gets a list of Host Catalogs.

Query Parameters

scope_id string

recursive boolean

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

HostCatalog manages Hosts and Host Sets

id string

Output only. The ID of the host.

scope_id string

The ID of the Scope of which this Host Catalog 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_id string

The ID of the plugin of which this catalog is created.

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 Host Catalog.

attributes object

Attributes specific to the catalog type.

secrets object

Secrets specific to the catalog type. These are never output.

secrets_hmac string

Output only. The HMAC of the last secrets supplied via the API, if any.

worker_filter string

Optional worker filter for plugin-subtype host catalogs. Boundary Enterprise only.

authorized_actions string[]

authorized_collection_actions object

Output only. The authorized actions for the scope's collections.

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 Host CatalogPOST/v1/host-catalogs

Creates a Host Catalog

Query Parameters

plugin_name string

As an alternative to providing the plugin id in the provided HostCatalog, this field can be used to lookup the plugin using its name.

Body Parameters

scope_id string

The ID of the Scope of which this Host Catalog is a part.

plugin_id string

The ID of the plugin of which this catalog is created.

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 Host Catalog.

attributes object

Attributes specific to the catalog type.

secrets object

Secrets specific to the catalog type. These are never output.

worker_filter string

Optional worker filter for plugin-subtype host catalogs. Boundary Enterprise only.

Successful Response

id string

Output only. The ID of the host.

scope_id string

The ID of the Scope of which this Host Catalog 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_id string

The ID of the plugin of which this catalog is created.

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 Host Catalog.

attributes object

Attributes specific to the catalog type.

secrets object

Secrets specific to the catalog type. These are never output.

secrets_hmac string

Output only. The HMAC of the last secrets supplied via the API, if any.

worker_filter string

Optional worker filter for plugin-subtype host catalogs. Boundary Enterprise only.

authorized_actions string[]

authorized_collection_actions object

Output only. The authorized actions for the scope's collections.

Get Host CatalogGET/v1/host-catalogs/{id}

Gets a single Host Catalog.

Path Parameters

id string

Successful Response

id string

Output only. The ID of the host.

scope_id string

The ID of the Scope of which this Host Catalog 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_id string

The ID of the plugin of which this catalog is created.

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 Host Catalog.

attributes object

Attributes specific to the catalog type.

secrets object

Secrets specific to the catalog type. These are never output.

secrets_hmac string

Output only. The HMAC of the last secrets supplied via the API, if any.

worker_filter string

Optional worker filter for plugin-subtype host catalogs. Boundary Enterprise only.

authorized_actions string[]

authorized_collection_actions object

Output only. The authorized actions for the scope's collections.

Delete Host CatalogDELETE/v1/host-catalogs/{id}

Deletes a Host Catalog

Path Parameters

id string

Update Host CatalogPATCH/v1/host-catalogs/{id}

Updates a Host Catalog

Path Parameters

id string

Body Parameters

scope_id string

The ID of the Scope of which this Host Catalog is a part.

plugin_id string

The ID of the plugin of which this catalog is created.

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 Host Catalog.

attributes object

Attributes specific to the catalog type.

secrets object

Secrets specific to the catalog type. These are never output.

worker_filter string

Optional worker filter for plugin-subtype host catalogs. Boundary Enterprise only.

Successful Response

id string

Output only. The ID of the host.

scope_id string

The ID of the Scope of which this Host Catalog 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_id string

The ID of the plugin of which this catalog is created.

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 Host Catalog.

attributes object

Attributes specific to the catalog type.

secrets object

Secrets specific to the catalog type. These are never output.

secrets_hmac string

Output only. The HMAC of the last secrets supplied via the API, if any.

worker_filter string

Optional worker filter for plugin-subtype host catalogs. Boundary Enterprise only.

authorized_actions string[]

authorized_collection_actions object

Output only. The authorized actions for the scope's collections.