---
title: "Validate Customer Portal connection"
method: GET
path: "/ticket_ssh_test"
tags: ["Support Tickets", "Support Access"]
---

# Validate Customer Portal connection

`GET /ticket_ssh_test`

This function verifies the connection from the
[cPanel Customer Portal](https://tickets.cpanel.net/)
to the server.

**Note:**

This function is **not** available through the command line. You **must** call it as
a request body.

## Query parameters

- `server_num` integer, required
- `ticket_id` integer, required

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `non_fatals` string[] — A list of non-fatal errors, if any exist. * `ticket_system_log_entry` — The function could not record the grant operation in the ticket. * `audit_log` — The function could not record the grant operation in the local audit log. The system stores the local audit log in the `/var/cpanel/logs/supportauth/audit.log` file.
    - `result` string — The SSH test's result.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` — Success. * `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)