Boundary Controller HTTP API
Session Service
Lists all Sessions.
Query Parameters
scope_id string recursive boolean filter string include_terminated boolean Experimental. By default only non-terminated (i.e. pending, active, canceling) are returned. Set this option to include terminated sessions as well.
list_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.
Successful Response
id string Output only. The ID of the Session.
target_id string Output only. The ID of the Target that created this Session.
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.
updated_time string Output only. The time this resource was last updated.
version integer Version is used when canceling this Session to ensure that the operation is acting on a known session state.
type string Output only. Type of the Session (e.g. tcp).
expiration_time string Output only. After this time the connection will be expired, e.g. forcefully terminated.
auth_token_id string Output only. The ID of the Auth Token used to authenticate.
user_id string Output only. The ID of the User that requested the Session.
host_set_id string Output only. The Host Set sourcing the Host for this Session.
host_id string Output only. The Host used by the Session.
scope_id string Output only. The Scope of the Session.
endpoint string Output only. The endpoint of the Session; that is, the address to which the worker is proxying data.
status string The status of the Session, e.g. "pending", "active", "canceling", "terminated".
start_time string Output only. The time the Session entered this state.
end_time string Output only. The time the Session stopped being in this state.
status string Output only. The current status of this Session.
certificate string Output only. The certificate generated for the session. Raw DER bytes.
termination_reason string Output only. If the session is terminated, this provides a short description as to why.
authorized_actions string[] client_tcp_address string client_tcp_address of the connection
client_tcp_port integer client_tcp_port of the connection
endpoint_tcp_address string endpoint_tcp_address of the connection
endpoint_tcp_port integer endpoint_tcp_port of the connection
bytes_up string bytes_up of the connection
bytes_down string bytes_down of the connection
closed_reason string closed_reason of the connection
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.
Gets a single Session.
Path Parameters
id string RequiredRequiredSuccessful Response
id string Output only. The ID of the Session.
target_id string Output only. The ID of the Target that created this Session.
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.
updated_time string Output only. The time this resource was last updated.
version integer Version is used when canceling this Session to ensure that the operation is acting on a known session state.
type string Output only. Type of the Session (e.g. tcp).
expiration_time string Output only. After this time the connection will be expired, e.g. forcefully terminated.
auth_token_id string Output only. The ID of the Auth Token used to authenticate.
user_id string Output only. The ID of the User that requested the Session.
host_set_id string Output only. The Host Set sourcing the Host for this Session.
host_id string Output only. The Host used by the Session.
scope_id string Output only. The Scope of the Session.
endpoint string Output only. The endpoint of the Session; that is, the address to which the worker is proxying data.
status string The status of the Session, e.g. "pending", "active", "canceling", "terminated".
start_time string Output only. The time the Session entered this state.
end_time string Output only. The time the Session stopped being in this state.
status string Output only. The current status of this Session.
certificate string Output only. The certificate generated for the session. Raw DER bytes.
termination_reason string Output only. If the session is terminated, this provides a short description as to why.
authorized_actions string[] client_tcp_address string client_tcp_address of the connection
client_tcp_port integer client_tcp_port of the connection
endpoint_tcp_address string endpoint_tcp_address of the connection
endpoint_tcp_port integer endpoint_tcp_port of the connection
bytes_up string bytes_up of the connection
bytes_down string bytes_down of the connection
closed_reason string closed_reason of the connection
Cancels a Session.
Path Parameters
id string RequiredRequiredBody Parameters
version integer Successful Response
id string Output only. The ID of the Session.
target_id string Output only. The ID of the Target that created this Session.
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.
updated_time string Output only. The time this resource was last updated.
version integer Version is used when canceling this Session to ensure that the operation is acting on a known session state.
type string Output only. Type of the Session (e.g. tcp).
expiration_time string Output only. After this time the connection will be expired, e.g. forcefully terminated.
auth_token_id string Output only. The ID of the Auth Token used to authenticate.
user_id string Output only. The ID of the User that requested the Session.
host_set_id string Output only. The Host Set sourcing the Host for this Session.
host_id string Output only. The Host used by the Session.
scope_id string Output only. The Scope of the Session.
endpoint string Output only. The endpoint of the Session; that is, the address to which the worker is proxying data.
status string The status of the Session, e.g. "pending", "active", "canceling", "terminated".
start_time string Output only. The time the Session entered this state.
end_time string Output only. The time the Session stopped being in this state.
status string Output only. The current status of this Session.
certificate string Output only. The certificate generated for the session. Raw DER bytes.
termination_reason string Output only. If the session is terminated, this provides a short description as to why.
authorized_actions string[] client_tcp_address string client_tcp_address of the connection
client_tcp_port integer client_tcp_port of the connection
endpoint_tcp_address string endpoint_tcp_address of the connection
endpoint_tcp_port integer endpoint_tcp_port of the connection
bytes_up string bytes_up of the connection
bytes_down string bytes_down of the connection
closed_reason string closed_reason of the connection