Boundary controller HTTP API
Session Recording Service
ListSessionRecordings lists all Session recordings. Session recordings are ordered by start_time descending (most recently started first).
Query Parameters
scope_id string The scope in which to list session recordings. Must be set unless recursive is set.
recursive boolean Whether to recurse into child scopes when listing. If set and scope_id is empty, shows session recordings in all scopes the caller has access to.
list_token string An opaque token that Boundary uses to continue an existing iteration or request updated items. If you do not specify a token, pagination starts from the beginning. To learn more about list pagination in Boundary, refer to list pagination.
page_size integer The maximum size of a page in this iteration. If you do not set a page size, Boundary uses the configured default page size. If the page_size is greater than the default page size configured, Boundary truncates the page size to this number.
Successful Response
id string The ID of the Session recording.
id string The ID of the scope.
type string The type of the scope.
name string The name of the scope, if any.
description string The description of the scope, if any.
parent_scope_id string The ID of the parent scope, if any. This field is empty if it is the "global" scope.
session_id string The ID of the Session which this Session Recording recorded.
storage_bucket_id string The ID of the Storage Bucket for the Target of this Session Recording.
bytes_up string The total number of bytes uploaded from the client in the Session. This includes all bytes uploaded over all Connections, including any protocol overhead.
bytes_down string The total number of bytes downloaded to the client in the Session. This includes all bytes downloaded over all Connections, including any protocol overhead.
created_time string The time the Session Recording was created in the controller.
updated_time string The time of the most recent update to the Session Recording.
start_time string The time the Session started.
end_time string The time the Session ended.
duration string The total duration of the Session.
type string Type of the Session that was recorded (e.g. ssh).
state string The current state of the session recording. One of "started", "available" and "unknown".
error_details string Any error seen during the closing of the session recording. Currently only set if state is "unknown".
mime_types string[] endpoint string The endpoint of the Session; that is, the address to which the egress worker connected.
id string The ID of the Connection recording.
bytes_up string The total number of bytes uploaded from the client in the Connection. This includes any protocol overhead.
bytes_down string The total number of bytes downloaded to the client in the Connection. This includes any protocol overhead.
created_time string The time the Connection was created in the controller.
updated_time string The time of the most recent update to the Connection.
start_time string The time the Connection started.
end_time string The time the Connection ended.
duration string The total duration of the Connection.
mime_types string[] id string The ID of the Channel recording.
bytes_up string The total number of bytes uploaded from the client in the Channel.
bytes_down string The total number of bytes downloaded to the client in the Channel.
created_time string The time the Channel was created in the controller.
updated_time string The time of the most recent update to the Channel.
start_time string The time the Channel started.
end_time string The time the Channel ended.
duration string The total duration of the Channel.
mime_types string[] id string The ID of the User.
name string The name of the User that created the Session.
description string The description of the User that created the Session.
id string The ID of the scope.
type string The type of the scope.
name string The name of the scope, if any.
description string The description of the scope, if any.
parent_scope_id string The ID of the parent scope, if any. This field is empty if it is the "global" scope.
id string The ID of the Target.
name string The name of the Target, if set.
description string The description of the Target, if set.
id string The ID of the scope.
type string The type of the scope.
name string The name of the scope, if any.
description string The description of the scope, if any.
parent_scope_id string The ID of the parent scope, if any. This field is empty if it is the "global" scope.
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.
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.
type string The type of the Target.
attributes object The attributes that are applicable for the specific Target.
id string The ID of the Host
id string The ID of the Host Catalog
id string The ID of the scope.
type string The type of the scope.
name string The name of the scope, if any.
description string The description of the scope, if any.
parent_scope_id string The ID of the parent scope, if any. This field is empty if it is the "global" scope.
plugin_id string The plugin id used by this Host Catalog, if any.
name string The name of the Host Catalog, if set
description string The description of the Host Catalog.
type string The type of the Host Catalog. This will be either "static" or "plugin"
attributes object The attributes of the Host Catalog.
name string The name of the Host, if set.
description string The description of the Host, if set.
type string The type of the host. This will be either "static" or "plugin"
attributes object The attributes that are applicable for the specific Host.
external_id string The external id of the Host, if any.
external_name string The external name of the Host, if any.
id string The ID of the Credential.
id string The ID of the Credential Store.
scope_id string The ID of the Scope of which this Credential Store is a part.
name string The name for identification purposes if set.
description string The description for identification purposes if set.
type string The Credential Store type.
attributes object The attributes that are applicable for the specific Credential Store type.
name string The name of the credential.
description string Optional user-set description.
purposes string[] type string The Credential type.
attributes object The attributes that are applicable for the specific Credential type.
id string The ID of the Credential Library.
id string The ID of the Credential Store.
scope_id string The ID of the Scope of which this Credential Store is a part.
name string The name for identification purposes if set.
description string The description for identification purposes if set.
type string The Credential Store type.
attributes object The attributes that are applicable for the specific Credential Store type.
name string Optional name of this Credential Library.
description string Optional user-set description of this Credential Library.
purposes string[] type string The Credential Library type.
attributes object The attributes that are applicable for the specific Credential Library type.
authorized_actions string[] retain_until string The time until a session recording is required to be stored.
delete_after string The time a session recording is scheduled to be automatically deleted.
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.
GetSessionRecording returns a stored Session recording if present. The provided request must include the Session recording ID for the Session recording being retrieved, or the ID of the Session that was recorded. If that ID is missing, malformed or reference a non existing resource, an error is returned.
Path Parameters
id string RequiredRequiredThe ID of the Session recording, or the ID of the Session that was recorded.
Successful Response
id string The ID of the Session recording.
id string The ID of the scope.
type string The type of the scope.
name string The name of the scope, if any.
description string The description of the scope, if any.
parent_scope_id string The ID of the parent scope, if any. This field is empty if it is the "global" scope.
session_id string The ID of the Session which this Session Recording recorded.
storage_bucket_id string The ID of the Storage Bucket for the Target of this Session Recording.
bytes_up string The total number of bytes uploaded from the client in the Session. This includes all bytes uploaded over all Connections, including any protocol overhead.
bytes_down string The total number of bytes downloaded to the client in the Session. This includes all bytes downloaded over all Connections, including any protocol overhead.
created_time string The time the Session Recording was created in the controller.
updated_time string The time of the most recent update to the Session Recording.
start_time string The time the Session started.
end_time string The time the Session ended.
duration string The total duration of the Session.
type string Type of the Session that was recorded (e.g. ssh).
state string The current state of the session recording. One of "started", "available" and "unknown".
error_details string Any error seen during the closing of the session recording. Currently only set if state is "unknown".
mime_types string[] endpoint string The endpoint of the Session; that is, the address to which the egress worker connected.
id string The ID of the Connection recording.
bytes_up string The total number of bytes uploaded from the client in the Connection. This includes any protocol overhead.
bytes_down string The total number of bytes downloaded to the client in the Connection. This includes any protocol overhead.
created_time string The time the Connection was created in the controller.
updated_time string The time of the most recent update to the Connection.
start_time string The time the Connection started.
end_time string The time the Connection ended.
duration string The total duration of the Connection.
mime_types string[] id string The ID of the Channel recording.
bytes_up string The total number of bytes uploaded from the client in the Channel.
bytes_down string The total number of bytes downloaded to the client in the Channel.
created_time string The time the Channel was created in the controller.
updated_time string The time of the most recent update to the Channel.
start_time string The time the Channel started.
end_time string The time the Channel ended.
duration string The total duration of the Channel.
mime_types string[] id string The ID of the User.
name string The name of the User that created the Session.
description string The description of the User that created the Session.
id string The ID of the scope.
type string The type of the scope.
name string The name of the scope, if any.
description string The description of the scope, if any.
parent_scope_id string The ID of the parent scope, if any. This field is empty if it is the "global" scope.
id string The ID of the Target.
name string The name of the Target, if set.
description string The description of the Target, if set.
id string The ID of the scope.
type string The type of the scope.
name string The name of the scope, if any.
description string The description of the scope, if any.
parent_scope_id string The ID of the parent scope, if any. This field is empty if it is the "global" scope.
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.
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.
type string The type of the Target.
attributes object The attributes that are applicable for the specific Target.
id string The ID of the Host
id string The ID of the Host Catalog
id string The ID of the scope.
type string The type of the scope.
name string The name of the scope, if any.
description string The description of the scope, if any.
parent_scope_id string The ID of the parent scope, if any. This field is empty if it is the "global" scope.
plugin_id string The plugin id used by this Host Catalog, if any.
name string The name of the Host Catalog, if set
description string The description of the Host Catalog.
type string The type of the Host Catalog. This will be either "static" or "plugin"
attributes object The attributes of the Host Catalog.
name string The name of the Host, if set.
description string The description of the Host, if set.
type string The type of the host. This will be either "static" or "plugin"
attributes object The attributes that are applicable for the specific Host.
external_id string The external id of the Host, if any.
external_name string The external name of the Host, if any.
id string The ID of the Credential.
id string The ID of the Credential Store.
scope_id string The ID of the Scope of which this Credential Store is a part.
name string The name for identification purposes if set.
description string The description for identification purposes if set.
type string The Credential Store type.
attributes object The attributes that are applicable for the specific Credential Store type.
name string The name of the credential.
description string Optional user-set description.
purposes string[] type string The Credential type.
attributes object The attributes that are applicable for the specific Credential type.
id string The ID of the Credential Library.
id string The ID of the Credential Store.
scope_id string The ID of the Scope of which this Credential Store is a part.
name string The name for identification purposes if set.
description string The description for identification purposes if set.
type string The Credential Store type.
attributes object The attributes that are applicable for the specific Credential Store type.
name string Optional name of this Credential Library.
description string Optional user-set description of this Credential Library.
purposes string[] type string The Credential Library type.
attributes object The attributes that are applicable for the specific Credential Library type.
authorized_actions string[] retain_until string The time until a session recording is required to be stored.
delete_after string The time a session recording is scheduled to be automatically deleted.
Deletes a Session Recording
Path Parameters
id string RequiredRequiredSuccessful Response
Download returns the contents of the specified resource in the specified mime type. Supports both Session ID and Session recording ID for looking up a Session recording. Supports both Connection ID and Connection recording ID to look up a Connection recording. A Channel recording ID is required to look up a Channel recording. The only supported mime type is "application/x-asciicast".
Path Parameters
id string RequiredRequiredThe ID of the resource that should be downloaded. Supported types:
- Session ID and Session recording ID for Session recordings
- Connection ID and Connection recording ID for Connection recordings
- Channel recording ID for Channel recordings
Query Parameters
mime_type string The format of the response. The only supported mime type is "application/x-asciicast". Defaults to "application/x-asciicast" if not set.
Successful Response
ReApplyStoragePolicy will recalculate the resultant set of policy and apply the result to the given session recording.
Path Parameters
id string RequiredRequiredThe Session Recording ID
Successful Response
id string The ID of the Session recording.
id string The ID of the scope.
type string The type of the scope.
name string The name of the scope, if any.
description string The description of the scope, if any.
parent_scope_id string The ID of the parent scope, if any. This field is empty if it is the "global" scope.
session_id string The ID of the Session which this Session Recording recorded.
storage_bucket_id string The ID of the Storage Bucket for the Target of this Session Recording.
bytes_up string The total number of bytes uploaded from the client in the Session. This includes all bytes uploaded over all Connections, including any protocol overhead.
bytes_down string The total number of bytes downloaded to the client in the Session. This includes all bytes downloaded over all Connections, including any protocol overhead.
created_time string The time the Session Recording was created in the controller.
updated_time string The time of the most recent update to the Session Recording.
start_time string The time the Session started.
end_time string The time the Session ended.
duration string The total duration of the Session.
type string Type of the Session that was recorded (e.g. ssh).
state string The current state of the session recording. One of "started", "available" and "unknown".
error_details string Any error seen during the closing of the session recording. Currently only set if state is "unknown".
mime_types string[] endpoint string The endpoint of the Session; that is, the address to which the egress worker connected.
id string The ID of the Connection recording.
bytes_up string The total number of bytes uploaded from the client in the Connection. This includes any protocol overhead.
bytes_down string The total number of bytes downloaded to the client in the Connection. This includes any protocol overhead.
created_time string The time the Connection was created in the controller.
updated_time string The time of the most recent update to the Connection.
start_time string The time the Connection started.
end_time string The time the Connection ended.
duration string The total duration of the Connection.
mime_types string[] id string The ID of the Channel recording.
bytes_up string The total number of bytes uploaded from the client in the Channel.
bytes_down string The total number of bytes downloaded to the client in the Channel.
created_time string The time the Channel was created in the controller.
updated_time string The time of the most recent update to the Channel.
start_time string The time the Channel started.
end_time string The time the Channel ended.
duration string The total duration of the Channel.
mime_types string[] id string The ID of the User.
name string The name of the User that created the Session.
description string The description of the User that created the Session.
id string The ID of the scope.
type string The type of the scope.
name string The name of the scope, if any.
description string The description of the scope, if any.
parent_scope_id string The ID of the parent scope, if any. This field is empty if it is the "global" scope.
id string The ID of the Target.
name string The name of the Target, if set.
description string The description of the Target, if set.
id string The ID of the scope.
type string The type of the scope.
name string The name of the scope, if any.
description string The description of the scope, if any.
parent_scope_id string The ID of the parent scope, if any. This field is empty if it is the "global" scope.
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.
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.
type string The type of the Target.
attributes object The attributes that are applicable for the specific Target.
id string The ID of the Host
id string The ID of the Host Catalog
id string The ID of the scope.
type string The type of the scope.
name string The name of the scope, if any.
description string The description of the scope, if any.
parent_scope_id string The ID of the parent scope, if any. This field is empty if it is the "global" scope.
plugin_id string The plugin id used by this Host Catalog, if any.
name string The name of the Host Catalog, if set
description string The description of the Host Catalog.
type string The type of the Host Catalog. This will be either "static" or "plugin"
attributes object The attributes of the Host Catalog.
name string The name of the Host, if set.
description string The description of the Host, if set.
type string The type of the host. This will be either "static" or "plugin"
attributes object The attributes that are applicable for the specific Host.
external_id string The external id of the Host, if any.
external_name string The external name of the Host, if any.
id string The ID of the Credential.
id string The ID of the Credential Store.
scope_id string The ID of the Scope of which this Credential Store is a part.
name string The name for identification purposes if set.
description string The description for identification purposes if set.
type string The Credential Store type.
attributes object The attributes that are applicable for the specific Credential Store type.
name string The name of the credential.
description string Optional user-set description.
purposes string[] type string The Credential type.
attributes object The attributes that are applicable for the specific Credential type.
id string The ID of the Credential Library.
id string The ID of the Credential Store.
scope_id string The ID of the Scope of which this Credential Store is a part.
name string The name for identification purposes if set.
description string The description for identification purposes if set.
type string The Credential Store type.
attributes object The attributes that are applicable for the specific Credential Store type.
name string Optional name of this Credential Library.
description string Optional user-set description of this Credential Library.
purposes string[] type string The Credential Library type.
attributes object The attributes that are applicable for the specific Credential Library type.
authorized_actions string[] retain_until string The time until a session recording is required to be stored.
delete_after string The time a session recording is scheduled to be automatically deleted.