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

Boundary Controller HTTP API

Session Service

List Sessions
GET /v1/sessions
Expand

Lists all Sessions.

Request

Query Parameters

scope_id string
recursive boolean
filter string

Response

Successful Response

items object[]

Session contains all fields related to a Session resource

id string

Output only. The ID of the Session.

target_id string

Output only. The ID of the Target that created 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.

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.

states object[]
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.

worker_info object[]
address string

The address of the worker.

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[]
Get Session
GET /v1/sessions/{id}
Expand

Gets a single Session.

Request

Path Parameters

id string Required

Response

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.

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.

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.

states object[]
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.

worker_info object[]
address string

The address of the worker.

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[]
Cancel Session
POST /v1/sessions/{id}:cancel
Expand

Cancels a Session.

Request

Path Parameters

id string Required

Body Parameters

id string
version integer

Response

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.

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.

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.

states object[]
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.

worker_info object[]
address string

The address of the worker.

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