v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB

SSH Keys

Import an ssh key for a site

post/v1/sites/{id}/ssh/keys

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Request body

namestring required

ssh key filename

keystring required

content of ssh key

passphrasestring

not needed for public ssh key import

Example request

{
  "name": "id_rsa.pub",
  "key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIGx6kfg1/JTqGu4AeALa7xV/Vw22KF82zKubXubwmuCU",
  "passphrase": "abracadabra"
}

Response

successboolean

whether the request succeeded

errorsstring[]

messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": []
}