Delete SSH key

Delete an SSH key.

DELETE

https://api.katapult.io/core/v1/ssh_keys/{ssh_key}

If successful, this endpoint will return a 200 OK status.

Arguments

The following arguments are supported for this endpoint.

Name	Type	Default Value
ssh_key Required	SSH Key Lookup	None

The following errors may occur during this request.

Details	HTTP status
deletion_restricted Object cannot be deleted	409 Conflict
permission_denied The authenticated identity is not permitted to perform this action	403 Forbidden
ssh_key_not_found No SSH key was found matching any of the criteria provided in the arguments	404 Not Found

Details

HTTP status

Object cannot be deleted

409 Conflict

The authenticated identity is not permitted to perform this action

403 Forbidden

No SSH key was found matching any of the criteria provided in the arguments

404 Not Found

When the request is successful, you can expect an object matching the specification below to be returned.

{
    ssh_key: AuthSSHKey {
        id: String
        name: String
        fingerprint: String
    }
}