SSH
15 min
the ssh connector is capable of running ssh commands prerequisites the ssh asset requires a host ip, username, and password capabilities the ssh connector has the following capabilities run command(s) get files put files configurations ssh authentication ssh authentication configuration parameters parameter description type required host address of the ssh server string required port port integer optional username username string required password password string required actions run command runs a command on an ssh server input argument name type required description command string required parameter for run command input example {"command" "ls la"} output parameter type description status code object http status code of the response reason string response reason phrase response object output field response response command string output field response command response stdout string output field response stdout response stderr string output field response stderr response exit code number output field response exit code output example {"status code"\ null,"response headers"\ null,"reason" "ok","response" {"command" "ls la","stdout" "total 36\ndrwxr xr x 5 serviceacct serviceacct 4096 jan 10 09 51 \ndrwxr xr x 4 r ","stderr" "","exit code" 0}} get file get a file input argument name type required description remotepath string required parameter for get file input example {"remotepath" "/home/serviceacct/connector test txt"} output parameter type description file object file file filename string name of the resource file file data string response data output example {"file" {"filename" "example name","file data" "string"}} put file put a file input argument name type required description form fields object required parameter for put file form fields files array optional parameter for put file form fields files file string optional parameter for put file form fields files file name string optional name of the resource remotepath string required parameter for put file input example {"remotepath" "/home/serviceacct/test file txt"} output parameter type description status code object http status code of the response reason string response reason phrase response object output field response response success boolean whether the operation was successful output example {"status code"\ null,"response headers"\ null,"reason" "ok","response" {"success"\ true}} response headers header description example content type the media type of the resource application/json date the date and time at which the message was originated thu, 01 jan 2024 00 00 00 gmt