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

Boundary Controller HTTP API

Target Service

List Targets
GET /v1/targets
Expand

Lists all Targets.

Request

Query Parameters

scope_id string
recursive boolean
filter string

Response

Successful Response

items object[]

Target contains all fields related to a Target resource

id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.

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

Required 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 Target.

host_set_ids string[]
host_sets object[]
id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Set belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_library_ids string[]
application_credential_libraries object[]
id string

The ID of the Credential Library.

name string

Output only. The name of the Credential Library.

description string

Output only. The description of the Credential Library.

credential_store_id string

Output only. The Credential Store to which this Credential Library belongs.

type string

Output only. The type of the credential library.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]
Create Target
POST /v1/targets
Expand

Creates a single Target.

Request

Body Parameters

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.

name string

Required 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 Target.

host_set_ids string[]
session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_library_ids string[]
attributes object

The attributes that are applicable for the specific Target.

Response

Successful Response

id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.

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

Required 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 Target.

host_set_ids string[]
host_sets object[]
id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Set belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_library_ids string[]
application_credential_libraries object[]
id string

The ID of the Credential Library.

name string

Output only. The name of the Credential Library.

description string

Output only. The description of the Credential Library.

credential_store_id string

Output only. The Credential Store to which this Credential Library belongs.

type string

Output only. The type of the credential library.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]
Get Target
GET /v1/targets/{id}
Expand

Gets a single Target.

Request

Path Parameters

id string Required

Response

Successful Response

id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.

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

Required 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 Target.

host_set_ids string[]
host_sets object[]
id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Set belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_library_ids string[]
application_credential_libraries object[]
id string

The ID of the Credential Library.

name string

Output only. The name of the Credential Library.

description string

Output only. The description of the Credential Library.

credential_store_id string

Output only. The Credential Store to which this Credential Library belongs.

type string

Output only. The type of the credential library.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]
Delete Target
DELETE /v1/targets/{id}
Expand

Deletes a Target.

Request

Path Parameters

id string Required

Response

Successful Response

No content.
Update Target
PATCH /v1/targets/{id}
Expand

Updates a Target.

Request

Path Parameters

id string Required

Query Parameters

update_mask string

Body Parameters

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.

name string

Required 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 Target.

host_set_ids string[]
session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_library_ids string[]
attributes object

The attributes that are applicable for the specific Target.

Response

Successful Response

id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.

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

Required 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 Target.

host_set_ids string[]
host_sets object[]
id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Set belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_library_ids string[]
application_credential_libraries object[]
id string

The ID of the Credential Library.

name string

Output only. The name of the Credential Library.

description string

Output only. The description of the Credential Library.

credential_store_id string

Output only. The Credential Store to which this Credential Library belongs.

type string

Output only. The type of the credential library.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]
Add Target Credential Libraries
POST /v1/targets/{id}:add-credential-libraries
Expand

Adds existing Credential Libraries to a Target.

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.

application_credential_library_ids string[]

Response

Successful Response

id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.

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

Required 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 Target.

host_set_ids string[]
host_sets object[]
id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Set belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_library_ids string[]
application_credential_libraries object[]
id string

The ID of the Credential Library.

name string

Output only. The name of the Credential Library.

description string

Output only. The description of the Credential Library.

credential_store_id string

Output only. The Credential Store to which this Credential Library belongs.

type string

Output only. The type of the credential library.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]
Add Target Host Sets
POST /v1/targets/{id}:add-host-sets
Expand

Adds existing Host Sets to a Target.

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

Response

Successful Response

id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.

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

Required 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 Target.

host_set_ids string[]
host_sets object[]
id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Set belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_library_ids string[]
application_credential_libraries object[]
id string

The ID of the Credential Library.

name string

Output only. The name of the Credential Library.

description string

Output only. The description of the Credential Library.

credential_store_id string

Output only. The Credential Store to which this Credential Library belongs.

type string

Output only. The type of the credential library.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]
Authorize Session
POST /v1/targets/{id}:authorize-session
Expand

Authorizes a Session.

Request

Path Parameters

id string Required

The ID of the target. Required unless some combination of scope_id/scope_name and name are set.

Body Parameters

id string

The ID of the target. Required unless some combination of scope_id/scope_name and name are set.

name string

The name of the target. When using this, scope_id or scope_name must be set.

scope_id string

The scope ID containing the target, if specifying the target by name.

scope_name string

The scope name containing the target, if specifying the target by name.

host_id string

An optional parameter allowing specification of the particular Host within the Target's configured Host Sets to connect to during this Session.

Response

Successful Response

session_id string

Output only. The ID of the Session.

target_id string

Output only. The ID of the Target authorizing this Session.

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.

created_time string

Output only. The time this resource was created.

user_id string

Output only. The User for which this Session was authorized.

host_set_id string

Output only. The Host Set containing the Host being used for this Session.

host_id string

Output only. The Host whose address is being used as the endpoint for this Session.

type string

Output only. Type of the Session (e.g. tcp, ssh, etc.).

authorization_token string

Output only. The marshaled SessionAuthorizationData message containing all information that the proxy needs.

endpoint string

Output only. The endpoint address that the worker will connect to, useful for setting TLS parameters.

credentials object[]

A credential for a session.

credential_library object

Output only. The library which generated this credential.

id string

The ID of the Credential Library.

name string

Output only. The name of the Credential Library.

description string

Output only. The description of the Credential Library.

credential_store_id string

Output only. The Credential Store to which this Credential Library belongs.

type string

Output only. The type of the credential library.

secret object

Output only. The secret of this credential base64 encoded.

raw string

Output only. The base64-encoded value representing the raw bytes from the credential provider.

decoded object

Output only. The decoded raw string, if a JSON object.

Remove Target Credential Libraries
POST /v1/targets/{id}:remove-credential-libraries
Expand

Removes Credential Libraries from the Target.

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.

application_credential_library_ids string[]

Response

Successful Response

id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.

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

Required 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 Target.

host_set_ids string[]
host_sets object[]
id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Set belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_library_ids string[]
application_credential_libraries object[]
id string

The ID of the Credential Library.

name string

Output only. The name of the Credential Library.

description string

Output only. The description of the Credential Library.

credential_store_id string

Output only. The Credential Store to which this Credential Library belongs.

type string

Output only. The type of the credential library.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]
Remove Target Host Sets
POST /v1/targets/{id}:remove-host-sets
Expand

Removes Host Sets from the Target.

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

Response

Successful Response

id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.

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

Required 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 Target.

host_set_ids string[]
host_sets object[]
id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Set belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_library_ids string[]
application_credential_libraries object[]
id string

The ID of the Credential Library.

name string

Output only. The name of the Credential Library.

description string

Output only. The description of the Credential Library.

credential_store_id string

Output only. The Credential Store to which this Credential Library belongs.

type string

Output only. The type of the credential library.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]
Set Target Credential Libraries
POST /v1/targets/{id}:set-credential-libraries
Expand

Sets the Credential Libraries on the Target.

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.

application_credential_library_ids string[]

Response

Successful Response

id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.

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

Required 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 Target.

host_set_ids string[]
host_sets object[]
id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Set belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_library_ids string[]
application_credential_libraries object[]
id string

The ID of the Credential Library.

name string

Output only. The name of the Credential Library.

description string

Output only. The description of the Credential Library.

credential_store_id string

Output only. The Credential Store to which this Credential Library belongs.

type string

Output only. The type of the credential library.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]
Set Target Host Sets
POST /v1/targets/{id}:set-host-sets
Expand

Sets the Host Sets on the Target.

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

Response

Successful Response

id string

Output only. The ID of the resource.

scope_id string

The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.

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

Required 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 Target.

host_set_ids string[]
host_sets object[]
id string

Output only. The ID of the Host Set.

host_catalog_id string

Output only. The Host Catalog to which this Host Set belongs.

session_max_seconds integer

Maximum total lifetime of a created Session, in seconds.

session_connection_limit integer

Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.

worker_filter string

Optional boolean expression to filter the workers that are allowed to satisfy this request.

application_credential_library_ids string[]
application_credential_libraries object[]
id string

The ID of the Credential Library.

name string

Output only. The name of the Credential Library.

description string

Output only. The description of the Credential Library.

credential_store_id string

Output only. The Credential Store to which this Credential Library belongs.

type string

Output only. The type of the credential library.

attributes object

The attributes that are applicable for the specific Target.

authorized_actions string[]