POST
/
plugins
/
runbooks
/
connections
/
{name}
/
exec

Path Parameters

name
string
required

The name of the connection

Body

application/json
file_name
string
required

The relative path name of the runbook file from the git source

client_args
string[]

Additional arguments to pass down to the connection

env_vars
object

Environment Variables that will be included in the runtime

  • { envvar:[env-key]: [base64-val] } - Expose the value as environment variable
  • { filesystem:[env-key]: [base64-val] } - Expose the value as a temporary file path creating the value in the filesystem
metadata
object

Metadata attributes to add in the session

parameters
object

The parameters of the runbook. It must match with the declared attributes

ref_hash
string

The commit sha reference to obtain the file

Response

200 - application/json
execution_time
integer

The amount of time the execution took in miliseconds

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
has_review
boolean

Inform if the connection has review enabled

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
session_id
string

Each execution creates a unique session id

truncated
boolean

If the `output`` field is truncated or not