# Validate remote server's SSH credentials

This function checks the SSH credentials on the remote server.

### Authentication
There are several methods that you can use to authenticate a transfer session with the remote server.

#### PermitRootLogin=Yes
The simplest authentication method is to use the  user and password. To do this, the  file on the remote server  contain the following value: 

The following table displays the correct parameters and values for this authentication method:

| Parameter | Value |
|-|-|
|  |  |
|  | 's password. |

You can also use the SSH Public Key to authenticate the  user. If the SSH Public Key is encrypted, include the SSH Key's passphrase.

The following table displays the correct parameters and values for this authentication method:

| Parameter | Value if the SSH Key is not encrypted | Value if the SSH Key is encrypted |
|-|-|-|
|  |  |  |
|  | 's SSH key name. | 's SSH key name. |
|  | (none) | 's SSH key passphrase. |

#### PermitRootLogin=No
Many server administrators do not permit direct root logins on their servers.
* If the remote server contains  in the file, then you  use another user and their password on the remote server, and then escalate to .
Manage Wheel Group UsersWHM >> Home >> Security Center >> Manage Wheel Group Users*) to grant the user  access, then you will need to specify  and the  password.
* If the user has  access, you do  need the  password.

The following table displays the correct parameters and values for this authentication method:

| Parameter | Value if the user has sudo access | Value if the user has su access |
|-|-|-|
|  | The user's username. | The user's username. |
|  | The user's password. | The user's password. |
|  |  |  |
|  | (none) | 's password. |

You can also use an SSH Public Key instead of a password to authenticate that user. If the SSH Public Key is encrypted, include the SSH Key's passphrase.

The following table displays the correct parameters and values for this authentication method:

| Parameter | sudo | su |
|-|-|-|
|  | The user's username. | The user's username. |
|  | The user's SSH key name. | The user's SSH key name. |
|  (If encrypted) | The user's SSH key passphrase. | The user's SSH key passphrase. |
|  |  |  |
|  | (none) | 's password. |

Endpoint: GET /remote_basic_credential_check
Version: 11.134.0.5
Security: BasicAuth

## Query parameters:

  - `host` (any, required)
    The remote server's hostname or IP address.
    Example: "192.168.0.0"

  - `user` (string, required)
    The username to use to connect to the remote server.
    Example: "root"

  - `password` (string)
    The username's password.
    Example: "123456luggage"

  - `port` (integer)
    The remote server's SSH port number.
    Example: 22

  - `root_escalation_method` (string)
    The escalation method to use to connect to the remote server.
* 
* 



 Use this parameter if  in the remote server's  file.
    Enum: "su", "sudo"

  - `root_password` (string)
    's password on the remote server.



 Use this parameter if  in the remote server's  file and the  value is set to .
    Example: "123456luggage"

  - `sshkey_name` (string)
    The SSH key's name.



 SSH keys are available in WHM's  interface ().
    Example: "FrancisScott"

  - `sshkey_passphrase` (string)
    The SSH key's passphrase.



 Use this parameter if the SSH Key is encrypted.
    Example: "kkwtoowoygidsa"

## Response 200 fields (application/json):

  - `data` (object)

  - `data.output` (string)
    The function call's raw HTML output.
    Example: "Basic credential check…\nDone\n"

  - `data.response` (string)
    The function call's response.
    Example: "basic credential check\n"

  - `metadata` (object)

  - `metadata.command` (string)
    The method name called.
    Example: "remote_basic_credential_check"

  - `metadata.reason` (string)
    The reason the API function failed when the  field is . This field may display a success message when a function succeeds.
    Example: "Success"

  - `metadata.result` (integer)
    *  - Success.
*  - Failed. Check the  field for more details.
    Enum: 0, 1

  - `metadata.version` (integer)
    The version of the API function.
    Example: 1