Boundary Controller HTTP API
Target Service
Lists all Targets.
Query Parameters
scope_id string recursive boolean filter string refresh_token string An opaque token used to continue an existing iteration or request updated items. If not specified, pagination will start from the beginning.
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, an error will be returned.
Creates a single Target.
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.
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. Deprecated; use egress or ingress worker filters instead.
egress_worker_filter string Optional boolean expressions to filter the egress workers that are allowed to satisfy this request.
ingress_worker_filter string Optional boolean expressions to filter the ingress workers that are allowed to satisfy this request. Unsupported on OSS.
attributes object The attributes that are applicable for the specific Target.
address string Optional string value that represents a network resource and is used when establishing a session.
Gets a single Target.
Path Parameters
id string RequiredDeletes a Target.
Path Parameters
id string RequiredUpdates a Target.
Path Parameters
id string RequiredBody 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.
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. Deprecated; use egress or ingress worker filters instead.
egress_worker_filter string Optional boolean expressions to filter the egress workers that are allowed to satisfy this request.
ingress_worker_filter string Optional boolean expressions to filter the ingress workers that are allowed to satisfy this request. Unsupported on OSS.
attributes object The attributes that are applicable for the specific Target.
address string Optional string value that represents a network resource and is used when establishing a session.
Adds existing Credential Sources to a Target.
Path Parameters
id string RequiredBody Parameters
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.
brokered_credential_source_ids string[] injected_application_credential_source_ids string[] Adds existing Host Sources to a Target. Cannot be used on targets that have their address field set.
Path Parameters
id string RequiredBody Parameters
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_source_ids string[] Authorizes a Session.
Path Parameters
id string RequiredThe ID of the target. Required unless some combination of scope_id/scope_name and name are set.
Body Parameters
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.
Removes Credential Sources from the Target.
Path Parameters
id string RequiredBody Parameters
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.
brokered_credential_source_ids string[] injected_application_credential_source_ids string[] Removes Host Sources from the Target.
Path Parameters
id string RequiredBody Parameters
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_source_ids string[] Sets the Credential Sources on the Target.
Path Parameters
id string RequiredBody Parameters
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.
brokered_credential_source_ids string[] injected_application_credential_source_ids string[] Sources the Host Sources on the Target. Cannot be used on targets that have their address field set.
Path Parameters
id string RequiredBody Parameters
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_source_ids string[]