Child pages
  • WHM API 1 Functions - ticket_ssh_test_start
Skip to end of metadata
Go to start of metadata

 

Description

This function initiates an SSH connection test.

Examples

 


 

 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/ticket_ssh_test_start?api.version=1&ticket_id=7650708&server_num=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api//ticket_ssh_test_start?api.version=1&ticket_id=7650708&server_num=1
 Command Line
whmapi1 ticket_ssh_test_start ticket_id 7650708 server_num 1

 


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
 {
	"data": {},
	"metadata": {
		"result": 1,
		"reason": "OK",
		"version": 1,
		"command": "ticket_ssh_test_start"
	}
}
 Output (XML)
<result>
	<data/>
	<metadata>
		<result>1</result>
		<reason>OK</reason>
		<version>1</version>
		<command>ticket_ssh_test_start</command>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
ticket_idinteger

Required

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

A positive integer.

7648492

server_numinteger

Required

An integer that represents the ticket's actionable server.

A positive integer. Increment the value by one for each server in the support ticket.

1

Returns

This function only returns metadata.