> For the complete documentation index, see [llms.txt](https://docs.nebulablock.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nebulablock.com/overview/platform_api/create_ssh_key/rename_ssh_key.md).

# Rename SSH Key

Updates the name of a specified SSH key. Include the ID of the SSH key in the endpoint path and the new name in the body of the request. To retrieve your SSH key IDs, see the [List SSH Keys API](/overview/platform_api/create_ssh_key/list_ssh_keys.md).

## HTTP Request

`PUT` `{API_URL}/ssh-keys/{id}`

## Path Parameters

| Parameters | Requirements | Type  | Description                                        |
| ---------- | ------------ | ----- | -------------------------------------------------- |
| id         | Required     | `int` | The unique identifier of the SSH key to be renamed |

## Body Parameters

| Parameters | Requirements | Type     | Description                 |
| ---------- | ------------ | -------- | --------------------------- |
| key\_name  | Required     | `string` | The new name of the SSH key |

## Response Attributes

#### data `dict`

Returns the `data` object, containing details of the updated SSH Key.

Each updated SSH key specifies the following properties:

* `id`: The ID of the SSH key.
* `key_name`: The new name of the SSH key.
* `key_data`: The SSH key value.
* `create_time`: The UNIX timestamp of when the SSH Key was created.

#### status `string`

Indicates the result of the request to rename a SSH key. `success` signifies success, while `failed` indicates an error.

#### message `string`

A description of the status of the request.

## Example

#### Request

```bash
curl -X PUT '{API_URL}/ssh-keys/76' \
-H 'Authorization: Bearer {TOKEN/KEY}' \
-d '{
    "key_name": "Test user was here",
}'
```

#### Response

```json
{
    "data": {
        "id": 76,
        "key_name": "Test user was here",
        "key_data": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD5",
        "create_time": "1730847956"
    },
    "message": "SSH key updated successfully",
    "status": "success"
}
```