testSSH |
---|
URL | /api/v1/api.php?target=auth&action=testSSH |
Description | Returns success or failure of a connection to an external server via SSH. |
Returns | Examples: SUCCESSFUL | {"success":1,"message":"Success!"} | ERROR | {'success':0, 'message':'error message'} |
|
Required Parameters | | | | |
---|
SSHServer | STRING | totally.awesome.com | IP or FQDN of server. | SSHPort | NUMBER | 22 | Port ssh is running on. |
|
Optional Parameters | | | | |
---|
username | STRING | jsmith | Username on target server. | password | STRING | password123 | Password for user. | directory | STRING | /tmp | Directory to attempt to access after successful login. | | | | |
|
Example URL | /api/v1/api.php?target=auth&action=testSSH&username=jsmith&password=password123&directory=%2Fvar%2Fnamed%2F6connect%2Fqa4&SSHPort=22&SSHServer=myssh.awesome.com |