# Rename an SSH key

URL: https://heaven.dev/docs/reference/ssh-keys/rename
Updated: 2026-11-21

Set an SSH key's label.

`POST /v1/account/ssh-key/modify`

## Parameters

- `key` (string, required): Active SSH key ID or exact label from `ssh-key view`. Use the ID if the label identifies more than one key.
- `label` (string, required): New SSH key label, from 1 to 200 bytes on one line.

## Returns

- `data` (object, always present): A saved setting.
  - `updated` (boolean, always present): Whether the request saved the setting.

## Errors

Each code is explained in full at https://heaven.dev/docs/reference/errors.

| Code | Status | What happened |
|---|---:|---|
| `invalid` | 400 | An input is missing or invalid. |
| `unauthenticated` | 401 | The credential is missing, invalid, expired or revoked. |
| `denied` | 403 | The caller lacks permission for this action. |
| `not_found` | 404 | The resource is absent or inaccessible to this caller. |
| `conflict` | 409 | The request conflicts with the current resource state or an earlier request. |
| `over_capacity` | 409 | The request exceeds a resource or credential allowance. |
| `access_list_full` | 409 | The change would exceed the access-list allowance. |
| `payment_required` | 402 | Payment or credit is required. |
| `rate_limited` | 429 | The caller's request rate exceeds its limit. |
| `busy` | 429 | Too much work is in progress to accept this request. |
| `unknown` | 503 | The outcome is unconfirmed; a change may have happened. |
| `unavailable` | 503 | The service or requested feature is unavailable. |

## Notes

- API key permission: `ssh-key rename`.

## Examples

```sh tab="heaven CLI"
heaven ssh-key rename KEY LABEL
```

```sh tab="SSH"
ssh cli@heaven.dev ssh-key rename KEY LABEL
```

```sh tab="cURL"
curl https://heaven.dev/v1/account/ssh-key/modify \
  -H "Authorization: Bearer $HEAVEN_API_KEY" \
  --json '{"action": "rename", "key": "f7b888e3-5211-4fab-a0bc-6f75ca06312a", "label": "deploy"}'
```

```json tab="MCP"
{ "tool": "ssh-key_rename",
  "arguments": { "key": "f7b888e3-5211-4fab-a0bc-6f75ca06312a", "label": "deploy" } }
```

Response:

```json title="Response excerpt"
{
  "version": 1,
  "data": {
    "updated": true
  }
}
```
