This API v3 documentation is currently still on progress. For any issue, please contact support@runcloud.io

RunCloud

Add SSH Key

POST

/servers/{{serverId}}/ssh/credentials

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

label

string

required

Label for SSH key

username

string

required

System user username

publicKey

string

required

SSH Public key

temporary

boolean

optional

give temporary SSH access (it will deleted after 7 hours), default value is 'false'

Example

{
  "label": "ali-ssh",
  "username": "root",
  "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDkT5cCaJpylLmPFAz0ptBcMsW6LuncfCtCQjUBRttzWZgAAFpmIMj8OqGo+fcZbvw/Tlro3wekxI74v1Vbvu9A70FsGNfGK6F2PRpB8HiWWXn/D8qyhVVyKrU9CCCfFOJTb6U69lQo0epDWuCQxpFfLO3du77TZMW/hEMMahXgpfZ7GZAf9EsLmrOX20xN/mplduB3FiEB+uM0jGx+WhuCFxxdJYxLsUHqS4nIsYFfMRHx43gwSHMLW691JffAgCG6s4fvYX9UsmxJ4GPzI5Z6nTmIbt34KTraKO33/TZjl34w26VBopTfnKTDHI8Jxq4AX9FC3Md3l9lQ7aIp+ys6RcDBWaEP/tV7WnsOoxsokitv1RfJnCsPmlNhyCq1+HNXsIUuMW/BV5IZpsX9B54NIn2kfo7kTgY35lf6Y7TS7M6WlR2kgvl1L34zc21x3QeYQsYf05GzXtRZDuDyKwfdU1u2zSREuLyDOGPCiZZ3a4KV7mdlH53U7KvVQG/twF0= [email protected]",
  "temporary": false
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://manage.runcloud.io/api/v3/servers/{{serverId}}/ssh/credentials' \
--header 'Content-Type: application/json' \
--data-raw '{
    "label": "ali-ssh",
    "username": "root",
    "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDkT5cCaJpylLmPFAz0ptBcMsW6LuncfCtCQjUBRttzWZgAAFpmIMj8OqGo+fcZbvw/Tlro3wekxI74v1Vbvu9A70FsGNfGK6F2PRpB8HiWWXn/D8qyhVVyKrU9CCCfFOJTb6U69lQo0epDWuCQxpFfLO3du77TZMW/hEMMahXgpfZ7GZAf9EsLmrOX20xN/mplduB3FiEB+uM0jGx+WhuCFxxdJYxLsUHqS4nIsYFfMRHx43gwSHMLW691JffAgCG6s4fvYX9UsmxJ4GPzI5Z6nTmIbt34KTraKO33/TZjl34w26VBopTfnKTDHI8Jxq4AX9FC3Md3l9lQ7aIp+ys6RcDBWaEP/tV7WnsOoxsokitv1RfJnCsPmlNhyCq1+HNXsIUuMW/BV5IZpsX9B54NIn2kfo7kTgY35lf6Y7TS7M6WlR2kgvl1L34zc21x3QeYQsYf05GzXtRZDuDyKwfdU1u2zSREuLyDOGPCiZZ3a4KV7mdlH53U7KvVQG/twF0= [email protected]",
    "temporary": false
}'

Responses

🟢200Success

application/json

Body

integer

required

System user ID

label

string

required

SSH key label

user

string

required

System user assigned to SSH key

publicKey

string

required

SSH key

temporary

boolean

required

Temporary/permanent

created_at

string

required

Time which system user

Example

{
  "id": 7,
  "label": "ali-ssh",
  "user": "root",
  "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDkT5cCaJpylL...",
  "temporary": false,
  "created_at": "2024-07-23 05:04:20"
}

Modified at 2025-01-31 08:25:32

Get SSH Key

Delete SSH Key