/ssh/key/add
POST https://api.sitehost.nz/1.2/ssh/key/add.json
Add a new SSH key to the client account.
Form Parameters
Parameter | Type | Required | Description |
client_id | integer | Yes | The ID of the client that the keys belong to.Example: 1 |
label | string | Yes | A label for the key to make it easier to identify.Example: My SSH Key |
content | string | Yes | The SSH key content.Example: ssh-rsa AAAAB3NzaC1yc2EAAA... user@host |
params[custom_image_access] | string | Whether or not this SSH key can access custom images.Example: 1 |
Code Samples
JavaScript PHP Rails Pythonvar xmlHttp = new XMLHttpRequest();
xmlHttp.open("POST", "https://api.sitehost.nz/1.2/ssh/key/add.json", false);
var data = new FormData();
data.append("apikey", "your_key_here");
data.append("client_id", "1");
data.append("label", "My SSH Key");
data.append("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/add.json");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
$body = array(
'apikey' => 'your_key_here',
'client_id' => 1,
'label' => 'My SSH Key',
'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/add.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,
"label" => "My SSH Key",
"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/add.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['label'] = 'My SSH Key'
body['content'] = 'ssh-rsa AAAAB3NzaC1yc2EAAA... user@host'
body['params[custom_image_access]'] = '1'
response = requests.post(uri, data=body)
Response
200:application/json
{
"return": {
"key_id": "45"
},
"msg": "Successful",
"status": true
}
"return": {
"key_id": "45"
},
"msg": "Successful",
"status": true
}