Path Parameters
The id of the resource
Query Parameters
Construct the file content adding the event time as prefix when parsing each event
0
, 1
Parse available options for the event stream
utf8
- parse the session output (o) and error (e) events as utf-8 content in the session payloadbase64
- parse the session output (o) and error (e) events as base64 content in the session payloadraw-queries
- encode each event stream parsing the input of queries based on the database wire protocol (available databases: postgres)
utf8
, base64
, raw-queries
Choose the type of events to include
i
- Input (stdin)o
- Output (stdout)e
- Error (stderr)
Expand the given attributes
event_stream
The file extension to donwload the session as a file content.
csv
- it will parse the content to format in csv formatjson
- it will parse the content as a json stream.<any-format>
- No special parsing is applied
Construct the file content adding a break line when parsing each event
0
, 1
Response
OK
The connection name of this resource
"pgdemo"
The subtype of the connection
"postgres"
The tags of the connection resource
{ "team": "banking;environment:prod" }
When the execution ended. A null value indicates the session is still running
"2024-07-25T15:56:35.361101Z"
The stored resource size in bytes.
When any parsing is applied to the request the value display the computed parsed size.
The pre-computed size will be available in the attribute metrics.event_size
569
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
The Linux exit code if it's available
The resource unique identifier
"1CBC8DB5-FBF8-4293-8E35-59A6EEA40207"
Metadata attributes related to integrations with third party services
DEPRECATED in flavor of metrics and metadata
Refactor to use a struct
The organization unique identifier
"0CD7F941-2BB8-4F9F-93B0-11620D4652AB"
Review of this session. In case the review doesn't exist this field will be null
The input of the session. This value is only set for the verb exec
{ "data": "SELECT NOW()" }
When the execution started
"2024-07-25T15:56:35.317601Z"
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
open
, ready
, done
The connection type of this resource
"database"
The user email of the resource
The user subject identifier of the resource
"nJ1xV3ASWGTi7L8Y6zvnKqxNlnZM2TxV1bRdc0706vZ"
The user display name of this resource
"John Wick"
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
connect
, exec