SiteHost API: /ssh/key/get

/ssh /key /get

GET https://api.sitehost.nz/1.0/ssh/key/get.json

Returns the requested SSH key.

Query Parameters

Parameter	Type	Required	Description
client_id	integer	Yes	The ID of the client that the keys belong to.Example: 1
key_id	integer	Yes	The ID of the SSH key to retrieve.Example: 1
include_users	boolean		Return the users associated with the key.Example: 1

Code Samples

JavaScript PHP Rails Python

var xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "https://api.sitehost.nz/1.0/ssh/key/get.json?apikey=your_key_here&client_id=1&key_id=1&include_users=1", false);

xmlHttp.send();

var response = xmlHttp.responseText;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.0/ssh/key/get.json?apikey=your_key_here&client_id=1&key_id=1&include_users=1");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$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.0/ssh/key/get.json?apikey=your_key_here&client_id=1&key_id=1&include_users=1")
http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Get.new(uri.request_uri)

response = http.request(request)

import requests

uri = 'https://api.sitehost.nz/1.0/ssh/key/get.json?apikey=your_key_here&client_id=1&key_id=1&include_users=1'

response = requests.get(uri)

Response

200:

application/json

{
  "return": {
    "id": "6",
    "client_id": "1",
    "label": "bruce",
    "content": "ssh key here",
    "date_added": "2014-12-18 09:29:24",
    "date_updated": "2016-02-09 15:09:52",
    "custom_image_access": false,
    "users" : [
      {
        "id": "12",
        "username": "john",
        "containers": [
          "mywebsite.nz"
        ]
      }
    ]
  },
  "msg": "Successful",
  "status": true,
  "time": 53.19
}