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.

SecurityBasicAuth

Request

query Parameters

server_num required	integer >= 1 The server's ID number. Example: server_num=2
ticket_id required	integer >= 1 The ticket's ID number. Example: ticket_id=999999999

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/ticket_ssh_test

Request samples

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

Response samples

application/json

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