SiteHost API: /ssh/key/list

/ssh /key /list_all

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

Returns a list of all SSH keys for a client.

Query Parameters

Parameter	Type	Required	Description
client_id	integer	Yes	The ID of the client that the keys belong to.Example: 1
filters[sort_by]	string		The field name to sort the results by.
filters[sort_dir]	string		The direction to sort in. Valid options are ASC and DESC
filters[page_size]	integer		The number of items to return per page.
filters[page_number]	integer		The page number to return.

Code Samples

JavaScript PHP Rails Python

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

xmlHttp.send();

var response = xmlHttp.responseText;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.0/ssh/key/list_all.json?apikey=your_key_here&client_id=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/list_all.json?apikey=your_key_here&client_id=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/list_all.json?apikey=your_key_here&client_id=1'

response = requests.get(uri)

Response

200:

application/json

{
  "return": {
    "total_items": 3,
    "current_items": 3,
    "current_page": 1,
    "total_pages": 1,
    "data": [
      {
        "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"
      },
      {
        "id": "7",
        "client_id": "1",
        "label": "alfred",
        "content": "ssh key here",
        "date_added": "2014-12-18 10:26:07",
        "date_updated": "2016-01-22 15:34:25"
      },
      {
        "id": "44",
        "client_id": "1",
        "label": "selina",
        "content": "ssh key here",
        "date_added": "2016-04-13 15:30:16",
        "date_updated": "2016-04-13 15:30:16"
      }
    ]
  },
  "msg": "Successful",
  "status": true,
  "time": 11.28
}