Delete SSH Key

Deletes a specified SSH key by including the ID of the SSH key in the endpoint path. To retrieve your SSH key IDs, see the List SSH Keys API.

HTTP Request

DELETE {API_URL}/ssh-keys/{id}

Path Parameters

Parameters	Requirements	Type	Description
id	Required	int	The unique identifier of the SSH key to be deleted

Response Attributes

data dict

Empty data object

status string

Indicates the result of the request to delete a SSH key. success signifies success, while failed indicates an error.

message string

A description of the status of the request.

Example

Request

curl -X DELETE '{API_URL}/ssh-keys/5' \
-H 'Authorization: Bearer {TOKEN/KEY}'

Response

{
    "data": {},
    "message": "SSH key deleted successfully",
    "status": "success"
}