Skip to content
Hayonix

API reference · SSH keys

Delete an SSH key

DELETE/v1/ssh-keys/{ssh_key_id}
API keyssh_key:deleteProject
TypeScript
client.sshKeys.delete()
Python
client.ssh_keys.delete()
CLI
hayonix ssh-keys delete

Removes the key from the project. Within moments pods stop accepting it, and open SSH sessions made with it are closed.

Project API key (Authorization: Bearer sk_…), or a console session. Requires the ssh_key:delete permission (a key's scope, or a role that includes it).

Examples

The samples read API_KEY and API_BASE_URL from the environment (see Setup). Values are examples.

curl -sS -X DELETE "$API_BASE_URL/ssh-keys/ssh_01jc5zq4m8k3v6x9t2w7r0b1e4" \
  -H "Authorization: Bearer $API_KEY"

Request

Headers
HeaderRequiredDescription
AuthorizationyesBearer and your API key. The key implies its project.
X-Project-Idsession onlyThe project to act in, for console sessions. Requests with an API key leave it out.

Path parameters

  • ssh_key_idstringrequired

    ID of the ssh key

    ID with prefix ssh_

Response

200 JSON — The key was deleted

  • idstringrequired

    ID of the deleted resource

  • objectstringrequired

    Always `ssh_key`

    One ofssh_key

  • deletedbooleanrequired

    Always true: the resource is deleted

    One oftrue

Example response
Example response
{
  "id": "string",
  "object": "ssh_key",
  "deleted": true
}

Errors

Errors use the standard envelope. What this operation can answer:

Errors
StatusTypeWhen
400invalid_request_errorA parameter or body field is missing or not allowed; param names it.
401authentication_errorThe key or session is missing, revoked or expired.
403permission_errorThe credential lacks the permission this needs, or the organization is suspended.
404not_found_errorNo such resource in this project (an ID from another project is answered the same way).
409conflict_errorThe resource's current state does not allow this.
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.