Return Support ticket status

This function lists all active and open support tickets from the cPanel Customer Portal.

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
ssh_username	string The username for incoming SSH connections before they escalate to the `root` user. If you do not specify a value, the function will select the user from the ticket. Example: ssh_username=username

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/ticket_list

Request samples

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

Response samples

application/json

{"data": {"auths": [{"servers": [{"auth_status": "AUTHED",
"auth_time": 1400603208,
"server_name": "My Server",
"server_num": 2,
"ssh": "10.11.12.13:22",
"ssh_username": "username",
"whm_ip": "10.11.12.13"
}
],
"ticket_id": 999999999,
"ticket_status": "OPEN",
"ticket_subject": "Example ticket"
}
],
"non_fatals": [ ]
},
"metadata": {"command": "ticket_list",
"reason": "OK",
"result": 1,
"version": 1
}
}