CPcpanel
Support Tickets
Support Access

Validate Support SSH connection

This function initiates an SSH connection test.

Important:

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

get/ticket_ssh_test_start

Request

  • Base URL
    https://whm-server.tld:2087/json-api
  • Auth
    HTTP basic

Query parameters

server_numinteger required
Example:1

An integer that represents the ticket's actionable server. Increment the value by one for each server in the support ticket.

ticket_idinteger required
Example:7648492

The support ticket number that other functions can use to query or make additional changes to the support ticket.

Response

HTTP Request was successful.

dataobject

Example response

{
  "metadata": {
    "command": "ticket_ssh_test_start",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.