> 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.md).

# SSH Keys

Creates an SSH key for use in your instances.

## HTTP Request

`POST` `{API_URL}/ssh-keys`

## Body Parameters

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

## Response Attributes

#### data `dict`

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

Each SSH key specifies the following properties:

* `id`: The ID of the SSH key.
* `key_name`: The 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 create 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 POST '{API_URL}/ssh-keys' \
-H 'Authorization: Bearer {TOKEN/KEY}' \
-d '{
    "name": "My Personal SSH Key",
    "key_data": "ssh-rsa AAADB3NzaC1yc2EBBACCAQABAAABAQD5",
}'
```

#### Response

```json
{
    "data": {
        "id": 73,
        "key_name": "My Personal SSH Key",
        "key_data": "ssh-rsa AAADB3NzaC1yc2EBBACCAQABAAABAQD5",
        "create_time": "1730847667"
    },
    "message": "SSH key created successfully",
    "status": "success"
}
```