• HashiCorp Developer

  • HashiCorp Cloud Platform
  • Terraform
  • Packer
  • Consul
  • Vault
  • Boundary
  • Nomad
  • Waypoint
  • Vagrant
Boundary
  • Install
  • Tutorials
  • Documentation
  • API
  • Try Cloud(opens in new tab)
  • Sign up
Boundary Home

API

Skip to main content
  • API

  • Account Service
  • Auth Method Service
  • Auth Token Service
  • Credential Library Service
  • Credential Service
  • Credential Store Service
  • Group Service
  • Host Catalog Service
  • Host Service
  • Host Set Service
  • Managed Group Service
  • Role Service
  • Scope Service
  • Session Service
  • Target Service
  • User Service
  • Worker Service

  • Resources

  • Tutorial Library
  • Community Forum
    (opens in new tab)
  • Support
    (opens in new tab)
  • GitHub
    (opens in new tab)
  1. Developer
  2. Boundary
  3. API
  4. Host Catalog Service

Boundary Controller HTTP API

Host Catalog Service


Gets a list of Host Catalogs.

Query Parameters

scope_id string
recursive boolean
filter 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.


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_id string

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


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.

authorized_actions string[]
authorized_collection_actions object

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


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.

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.


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_id string

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


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.

authorized_actions string[]
authorized_collection_actions object

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


Gets a single Host Catalog.

Path Parameters

id string RequiredRequired

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.


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_id string

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


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.

authorized_actions string[]
authorized_collection_actions object

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


Deletes a Host Catalog

Path Parameters

id string RequiredRequired

Successful Response

No content.

Updates a Host Catalog

Path Parameters

id string RequiredRequired

Query Parameters

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

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.


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_id string

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


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.

authorized_actions string[]
authorized_collection_actions object

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

Give Feedback(opens in new tab)
  • Certifications
  • System Status
  • Terms of Use
  • Security
  • Privacy
  • Trademark Policy
  • Trade Controls
  • Give Feedback(opens in new tab)