/ssh/key/update


POST https://api.sitehost.nz/1.2/ssh/key/update.json

Update the specified SSH key.

Form Parameters

ParameterTypeRequiredDescription
client_idintegerYesThe ID of the client that the key belongs to.Example: 1
key_idintegerYesThe ID of the SSH key to update.Example: 1
params[label]stringYesA label for the key to make it easier to identify.Example: My SSH Key
params[content]stringYesThe SSH key content.Example: ssh-rsa AAAAB3NzaC1yc2EAAA... user@host
params[custom_image_access]stringWhether or not this SSH key can access custom images.Example: 1

Code Samples

JavaScript PHP Rails Python
var xmlHttp = new XMLHttpRequest();
xmlHttp.open("POST", "https://api.sitehost.nz/1.2/ssh/key/update.json", false);

var data = new FormData();
data.append("apikey", "your_key_here");
data.append("client_id", "1");
data.append("key_id", "1");
data.append("params[label]", "My SSH Key");
data.append("params[content]", "ssh-rsa AAAAB3NzaC1yc2EAAA... user@host");
data.append("params[custom_image_access]", "1");

xmlHttp.send(data);

var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.2/ssh/key/update.json");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
$body = array(
'apikey' => 'your_key_here',
'client_id' => 1,
'key_id' => 1,
'params[label]' => 'My SSH Key',
'params[content]' => 'ssh-rsa AAAAB3NzaC1yc2EAAA... user@host',
'params[custom_image_access]' => '1',
);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
require 'net/http'
require 'uri'

uri = URI.parse("https://api.sitehost.nz/1.2/ssh/key/update.json")
http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Post.new(uri.request_uri)

body = {"apikey" => "your_key_here",
"client_id" => 1,
"key_id" => 1,
"params[label]" => "My SSH Key",
"params[content]" => "ssh-rsa AAAAB3NzaC1yc2EAAA... user@host",
"params[custom_image_access]" => "1",
}
request.set_form_data(body)

response = http.request(request)
import requests
from collections import OrderedDict

uri = 'https://api.sitehost.nz/1.2/ssh/key/update.json'

# We need ordered dictionary because parameters have to be in the right order.
# Refer to Developer Notes for more information.
body = OrderedDict()

body['apikey'] = 'your_key_here'
body['client_id'] = 1
body['key_id'] = 1
body['params[label]'] = 'My SSH Key'
body['params[content]'] = 'ssh-rsa AAAAB3NzaC1yc2EAAA... user@host'
body['params[custom_image_access]'] = '1'

response = requests.post(uri, data=body)

Response

200:

application/json
{
  "msg": "Successful.",
  "status": true
}