latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Support Tickets
Support Access

Create Support SSH key

This function installs an SSH key 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_grant

Query parameters

secure_idstring required
Example:rofh411bv8

The support ticket's secure ID token.

server_numinteger required
Example:1

The server's support ticket ID number.

ticket_idinteger required
Example:999999999

The support 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 retrieves the user from the support ticket.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "auth_status": "AUTHED",
    "auth_time": 1477338450,
    "chain_status": "ACTIVE",
    "csf_wl_status": "ACTIVE",
    "host_access_wl_status": "ACTIVE",
    "hulk_wl_status": "ACTIVE",
    "non_fatals": [],
    "server_name": "example",
    "server_num": 1,
    "ssh_username": "username",
    "ticket_id": 999999999,
    "ticket_status": "OPEN"
  },
  "metadata": {
    "command": "ticket_grant",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}