GET
/
sessions
/
{session_id}

Path Parameters

session_id
string
required

The id of the resource

Query Parameters

event-time
enum<string>
default: 0

Construct the file content adding the event time as prefix when parsing each event

Available options:
0,
1
event_stream
enum<string>

This option will parse the session output (o) and error (e) events as an utf-8 content in the session payload

Available options:
utf8
events
string[]

Choose the type of events to include

  • i - Input (stdin)
  • o - Output (stdout)
  • e - Error (stderr)
extension
string

The file extension to donwload the session as a file content.

  • csv - it will parse the content to format in csv format
  • json - it will parse the content as a json stream.
  • <any-format> - No special parsing is applied
new_line
enum<string>
default: 0

Construct the file content adding a break line when parsing each event

Available options:
0,
1

Response

200 - application/json
connection
string

The connection name of this resource

end_date
string

When the execution ended. A null value indicates the session is still running

event_size
integer

The stored resource size in bytes

event_stream
any[]

The stream containing the output of the execution in the following format

[[0.268589438, "i", "ZW52"], ...]

  • <event-time> - relative time in miliseconds to start_date
  • <event-type> - the event type as string (i: input, o: output e: output-error)
  • <base64-content> - the content of the session encoded as base64 string
id
string

The resource unique identifier

jira_issue
string
labels
object

DEPRECATED in flavor of metrics and metadata

metadata
object
metrics
object

Refactor to use a struct

org_id
string

The organization unique identifier

review
object

Review of this session. In case the review doesn't exist this field will be null

script
object

The input of the session. This value is only set for the verb exec

start_date
string

When the execution started

status
enum<string>

Status of the resource

  • ready - the resource is ready to be executed, after being approved by a user
  • open - the session started and it's running
  • done - the session has finished
Available options:
open,
ready,
done
type
string

The connection type of this resource

user
string

The user email of the resource

user_id
string

The user subject identifier of the resource

user_name
string

The user display name of this resource

verb
enum<string>

Verb is how the client has interacted with this resource

  • exec - Is an ad-hoc shell execution
  • connect - Interactive execution, protocol port forwarding or interactive shell session
Available options:
connect,
exec