POST
/
sessions
Exec
curl --request POST \
  --url https://use.hoop.dev/api/sessions \
  --header 'Content-Type: application/json' \
  --data '{
  "client_args": [
    "--verbose"
  ],
  "connection": "bash",
  "labels": {},
  "metadata": {},
  "script": "echo '\''hello from hoop'\''"
}'
{
  "execution_time": 5903,
  "exit_code": 1,
  "has_review": false,
  "output": "<string>",
  "output_status": "failed",
  "session_id": "5701046A-7B7A-4A78-ABB0-A24C95E6FE54",
  "truncated": false
}

Body

application/json

The request body resource

​
client_args
string[]

Additional arguments that will be joined when construction the command to be executed

Example:
["--verbose"]
​
connection
string

The target connection

Example:

"bash"

​
labels
object

DEPRECATED in flavor of metadata

​
metadata
object

Metadata contains attributes that is going to be available in the Session resource

​
script
string

The input of the execution

Example:

"echo 'hello from hoop'"

Response

The execution has finished

​
execution_time
integer

The amount of time the execution took in miliseconds

Example:

5903

​
exit_code
integer

The shell exit code, any non zero code means an error

  • 0 - Linux success exit code
  • -2 - internal gateway code that means it was unable to obtain a valid exit code number from the agent outcome packet
  • 254 - internal agent code that means it was unable to obtain a valid exit code number from the process
Example:

1

​
has_review
boolean

Inform if the connection has review enabled

Example:

false

​
output
string

Output contains an utf-8 output containing the outcome of the ad-hoc execution

​
output_status
enum<string>

Status reports if the outcome of the execution

  • success - The execution was executed with success
  • failed - In case of internal error or when the agent returns an exit code greater than 0 or different than -2
  • running - The execution may still be running.
Available options:
success,
failed,
running
Example:

"failed"

​
session_id
string<uuid>

Each execution creates a unique session id

Example:

"5701046A-7B7A-4A78-ABB0-A24C95E6FE54"

​
truncated
boolean

If the `output`` field is truncated or not

Example:

false