vessl-docs / reference /sdk /ssh-key.md
sanghyuk-vessl's picture
Add vessl-docs
76d9c4f verified
---
title: SSH-key
version: EN
---
### list_ssh_keys
```python
vessl.list_ssh_keys()
```
List ssh public keys.
**Example**
```python
vessl.list_ssh_keys()
```
----
## create_ssh_key
```python
vessl.create_ssh_key(
key_path: str, key_name: str, ssh_public_key_value: str
)
```
Create a SSH public key.
**Args**
* `key_path` (str) : SSH public key path.
* `key_name` (str) : SSH public key name,
* `ssh_public_key_value` (str) : SSH public key value.
**Example**
```python
vessl.create_ssh_key(
key_path="/Users/johndoe/.ssh/id_ed25519.pub",
key_name="john@abcd.com",
ssh_public_key_value="ssh-public-key-value",
)
```
----
## delete_ssh_key
```python
vessl.delete_ssh_key(
key_id: int
)
```
Delete the ssh public key.
**Args**
* `key_id` (int) : Key ID.
**Example**
```python
vessl.delete_ssh_key(
key_id=123456,
)
```