latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Support Tickets
Ticket Management

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.

get/ticket_list

Query parameters

server_numinteger required
Example:2

The server's ID number.

ticket_idinteger required
Example:999999999

The ticket's ID number.

ssh_usernamestring
Example:username

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.

Response

HTTP Request was successful.

Example response

{
  "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
  }
}