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.

Authorizations:
query Parameters
server_num
required
integer >= 1

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

Example: server_num=1
ticket_id
required
integer

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

Example: ticket_id=7648492

Responses

Response Schema: application/json
data
object
object

Request samples

https://hostname.example.com:2087/cpsess##########/json-api/ticket_ssh_test_start?api.version=1&ticket_id=7648492&server_num=1

Response samples

Content type
application/json
{
  • "data": { },
  • "metadata": {
    • "command": "ticket_ssh_test_start",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}