Child pages
  • WHM API 1 Functions - ticket_ssh_test_start

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function initiates an SSH connection test.

Panel
bgColor#F2F2F2
borderStylenone

Examples

 


 

Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/ticket_ssh_test_start?api.version=1&ticket_id=7650708&server_num=1
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api//ticket_ssh_test_start?api.version=1&ticket_id=7650708&server_num=1
Expand
titleCommand Line
Code Block
whmapi1 ticket_ssh_test_start ticket_id 7650708 server_num 1

 

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
 {
	"data": {},
	"metadata": {
		"result": 1,
		"reason": "OK",
		"version": 1,
		"command": "ticket_ssh_test_start"
	}
}
Expand
titleOutput (XML)
Code Block
languagexml
linenumberstrue
<result>
	<data/>
	<metadata>
		<result>1</result>
		<reason>OK</reason>
		<version>1</version>
		<command>ticket_ssh_test_start</command>
</result>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

   

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.