# Validate host

This function checks whether a host's public key exists in the cPanel account's  file.

Endpoint: GET /KnownHosts/verify
Version: 11.134.0.5
Security: BasicAuth

## Query parameters:

  - `host_name` (any, required)
    The host to query.
    Example: "host.example.com"

  - `port` (integer)
    The SSH port to use.
    Example: 1234

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "verify"

  - `module` (string)
    The name of the module called.
    Example: "KnownHosts"

  - `result` (object)

  - `result.data` (object)

  - `result.data.errors` (array)
    An array of errors that the system generated.
    Example: ["The example.com host does not exist in the known_hosts file."]

  - `result.data.failure_type` (string)
    The reason why the system will register the hostname.
*  — The host does  already exist.
*  — The host's information has changed.
    Enum: "new", "changed"

  - `result.data.host` (array)
    An array of objects that contain information about the host.

  - `result.data.host.host` (any)
    The hostname or IP address.
    Example: "host.example.com"

  - `result.data.host.key` (string)
    The host's key.
    Example: "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ=="

  - `result.data.host.line` (string)
    The host's entry in the  file, where  is the cPanel account username.
    Example: "host.example.com ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ=="

  - `result.data.host.meta` (object)
    An object that contains information about the host's public key.

  - `result.data.host.meta.algorithm` (string)
    The key's algorithm.
    Example: "ssh-rsa"

  - `result.data.host.meta.body` (string)
    The host's public key. public key.
    Example: "AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ=="

  - `result.data.host.meta.md5` (string)
    The key's [MD5](https://en.wikipedia.org/wiki/MD5) fingerprint.
    Example: "b6030e39979ed0e724cea3773e014209"

  - `result.data.host.meta.md5-printable` (string)
    A human-readable version of the key's MD5 fingerprint.
    Example: "MD5:b6:03:0e:39:97:9e:d0:e7:24:ce:a3:77:3e:01:42:09"

  - `result.data.host.meta.sha256` (string)
    The key's [SHA-256](https://en.wikipedia.org/wiki/SHA-2) fingerprint.
    Example: "44e405bcf4e11ab5b846e58ba0bf6dabd23dcc9e367cae17cb0c91b5b3b3fc44"

  - `result.data.host.meta.sha256-printable` (string)
    A human-readable version of the key's SHA-256 fingerprint.
    Example: "SHA256:ROQFvPThGrW4RuWLoL9tq9I9zJ42fK4XywyRtbOz/EQ"

  - `result.data.status` (integer)
    Whether the host already exists in the  file, where  is the cPanel account username.
*  — Exists.
*  — The host does  already exist, or the system must re-register the hostname.
    Enum: 0, 1

  - `result.errors` (array,null)
    List of errors if the API failed.

  - `result.messages` (array,null)
    List of messages generated by the API.

  - `result.metadata` (object)

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

  - `result.warnings` (array,null)
    List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.