---
title: "Enable SSH key for server"
method: GET
path: "/authorizesshkey"
tags: ["SSH Keys and Connections"]
---

# Enable SSH key for server

`GET /authorizesshkey`

This function authorizes a public SSH key to access the server.
When you call this function, it adds the key to the `/root/.ssh/authorized_keys` file.

**Warning:**

* Do **not** transfer private keys over insecure ports.
* Only `root` and `root`-enabled resellers can use this function, and it only affects
the `root` public SSH keys. To perform this function on a regular user account, call
the cPanel API 2 `SSH::authkey` function via the WHM API. For more information, read our
[Use WHM API to Call cPanel API and UAPI](https://go.cpanel.net/UseWHMAPItoCallcPanelAPIandUAPI)
documentation.

## Query parameters

- `authorize` 1 | 0, required
- `file` string, required
- `text` string, required
- `options` string

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `authorized` 1 | 0 — Whether the public SSH key has authorization. * `1` — Authorized. * `0` — **Not** authorized.
    - `file` string — The public SSH key file's name.
  - `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` 1 | 0 — * `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)