Update SSH Key

PATCH

https://api.vpsbg.eu/v1/ssh-keys/{id}

You can update a saved SSH key. If the value of some input is empty, it will retain its original value. Updating your SSH key will not update the ssh key on your previously deployed servers.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string

required

Header Params

string

required

Default:

application/json

Body Params application/json

name

string

optional

>= 3 characters<= 100 characters

key

string

optional

Example:

ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDJXgSGIiC3OMJtZrGBLY4rpfPjwWZiJtcG4JLUOWCt5h6cSQ4ESRFzCzK4uz6XM1ZjizGj8r2T5IA+9nAdXZAmD8p9mZ8eYFz8QY/URBsn2ohX4NVR9ScGbr3Z3q6Vq6aK6YbW+J++CmgM5sV6BZhMkvr5V55MP0KGS3hCV02OqQ4+q9jc6RXHZLJ2eSH7KrMz7ZTsV4yC5lfCwCfDdzeKU9ZjTjsGHU4N5nWnApJb7s1L2GdJ1F6QQNc6vN1z0SlZL9QqjMG3AicSiqJlRzAFK2u0xszj6wvgPhTZ/xsmdgH+b9y2r0bl6pLzImh0I6FCRRIm2JdFmlDnqQb user@example.com

Match pattern:

/^(ssh-(rsa|ed25519)) [A-Za-z0-9+\/=]+(\s.+)?$/

restart_servers

boolean

optional

Restarts all servers associated with this ssh key.

Default:

false

Example

{
    "name": "string",
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDJXgSGIiC3OMJtZrGBLY4rpfPjwWZiJtcG4JLUOWCt5h6cSQ4ESRFzCzK4uz6XM1ZjizGj8r2T5IA+9nAdXZAmD8p9mZ8eYFz8QY/URBsn2ohX4NVR9ScGbr3Z3q6Vq6aK6YbW+J++CmgM5sV6BZhMkvr5V55MP0KGS3hCV02OqQ4+q9jc6RXHZLJ2eSH7KrMz7ZTsV4yC5lfCwCfDdzeKU9ZjTjsGHU4N5nWnApJb7s1L2GdJ1F6QQNc6vN1z0SlZL9QqjMG3AicSiqJlRzAFK2u0xszj6wvgPhTZ/xsmdgH+b9y2r0bl6pLzImh0I6FCRRIm2JdFmlDnqQb user@example.com",
    "restart_servers": false
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.vpsbg.eu/v1/ssh-keys/' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDJXgSGIiC3OMJtZrGBLY4rpfPjwWZiJtcG4JLUOWCt5h6cSQ4ESRFzCzK4uz6XM1ZjizGj8r2T5IA+9nAdXZAmD8p9mZ8eYFz8QY/URBsn2ohX4NVR9ScGbr3Z3q6Vq6aK6YbW+J++CmgM5sV6BZhMkvr5V55MP0KGS3hCV02OqQ4+q9jc6RXHZLJ2eSH7KrMz7ZTsV4yC5lfCwCfDdzeKU9ZjTjsGHU4N5nWnApJb7s1L2GdJ1F6QQNc6vN1z0SlZL9QqjMG3AicSiqJlRzAFK2u0xszj6wvgPhTZ/xsmdgH+b9y2r0bl6pLzImh0I6FCRRIm2JdFmlDnqQb user@example.com",
    "restart_servers": false
}'

Responses

🟢200When update is successfully, it will return the updated resource.

application/json

Body

integer

optional

name

string

optional

fingerprint

string

required

Example:

c3:02:91:64:1f:e3:da:4b:7e:9e:33e:14:qf:4d:39:73

key

string

optional

servers

array [object {2}]

required

Array of all server ids attached to this ssh key.

integer

required

hostname

string

required

Example

{
    "id": 90,
    "name": "Example SSH Key",
    "fingerprint": "c3:02:91:64:1f:e3:da:4b:7e:9e:33e:14:qf:4d:39:73",
    "key": "ssh-rsa AA... user@example.com",
    "servers": [
        {
            "id": 2922,
            "hostname": "ubuntu-1gb"
        },
        {
            "id": 2930,
            "hostname": "debian-1gb"
        }
    ]
}

🟠401Unauthorized

🟠422Validation error (specified in the response)

🔴500Server Error

Modified at 2025-06-20 08:57:05

Get an SSH Key

Delete SSH Key