---
title: "Create SSH key pair"
method: GET
path: "/generatesshkeypair"
tags: ["SSH Keys and Connections"]
---

# Create SSH key pair

`GET /generatesshkeypair`

This function generates an SSH key pair.

## Query parameters

- `abort_on_existing_key` 0 | 1
- `algorithm` 'rsa2' | 'dsa'
- `bits` 1024 | 2048 | 4096
- `comment` string
- `name` string
- `passphrase` string

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `fingerprint` string, md5, nullable — The key's [MD5](https://en.wikipedia.org/wiki/MD5) fingerprint.
    - `name` string — The key's filename.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` — Success. * `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)