POST
/
plugins
/
runbooks
/
connections
/
{name}
/
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",
  "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

The name of the connection

Body

application/json
The request body resource

The body is of type object.

Response

200
application/json
The execution has finished

The response is of type object.