Skip to main content
POST
/
plugins
/
runbooks
/
connections
/
{name}
/
exec
Runbook Exec
curl --request POST \
  --url https://use.hoop.dev/api/plugins/runbooks/connections/{name}/exec \
  --header 'Content-Type: application/json' \
  --data '{
  "client_args": [
    "--verbose"
  ],
  "env_vars": {
    "envvar": "PASSWORD:MTIz",
    "filesystem": "SECRET_FILE:bXlzZWNyZXQ="
  },
  "file_name": "myrunbooks/run-backup.runbook.sql",
  "jira_fields": {},
  "metadata": {},
  "parameters": {
    "amount": "10",
    "wallet_id": "6736"
  },
  "ref_hash": "20320ebbf9fc612256b67dc9e899bbd6e4745c77"
}'
{
  "execution_time": 5903,
  "exit_code": 1,
  "has_review": false,
  "output": "<string>",
  "output_status": "failed",
  "session_id": "5701046A-7B7A-4A78-ABB0-A24C95E6FE54",
  "truncated": false
}

Path Parameters

​
name
string
required

Body

application/json
​
file_name
string
required
Example:
​
client_args
string[]
Example:
​
env_vars
object
Example:
​
jira_fields
object
​
metadata
object
​
parameters
object
Example:
​
ref_hash
string
Example:

Response

​
execution_time
integer
Example:
​
exit_code
integer
Example:
​
has_review
boolean
Example:
​
output
string
​
output_status
enum<string>
Available options:
success,
failed,
running
Example:
​
session_id
string<uuid>
Example:
​
truncated
boolean
Example: