Delete Support SSH key

This function removes a cPanel Customer Portal SSH key from the server.

Note:

This function is not available through the command line. You must call it as a request body.

Authorizations:
query Parameters
server_num
required
integer >= 1

The server's ID number.

Example: server_num=1
ssh_username
required
string

The username for incoming SSH connections before they escalate to the root user.

Example: ssh_username=username
ticket_id
required
integer >= 1

The support ticket's ID number.

Example: ticket_id=999999999

Responses

Response Schema: application/json
object
object

Request samples

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

Response samples

Content type
application/json
{
  • "data": {
    • "chain_status": "ACTIVE",
    • "csf_wl_status": "ACTIVE",
    • "host_access_wl_status": "ACTIVE",
    • "hulk_wl_status": "ACTIVE",
    • "non_fatals": [ ],
    • "revoked_keys": 1,
    • "server_num": 2,
    • "ssh_username": "username",
    • "ticket_id": 999999999
    },
  • "metadata": {
    • "command": "ticket_revoke",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}