latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Support Tickets
Support Access

Validate Customer Portal connection

This function verifies the connection from the cPanel Customer Portal to the server.

Note:

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

get/ticket_ssh_test

Query parameters

server_numinteger required
Example:2

The server's ID number.

ticket_idinteger required
Example:999999999

The ticket's ID number.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "non_fatals": [
      "audit_log"
    ],
    "result": "SUCCESS"
  },
  "metadata": {
    "command": "ticket_ssh_test",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}