SiteHost API: /cloud/server/list

/cloud /server /list_all

GET https://api.sitehost.nz/1.3/cloud/server/list_all.json

Returns a list of Cloud Container servers for the specified client.

Query Parameters

Parameter	Type	Required	Description
client_id	integer	Yes	The ID for the client that the servers belong to.Example: 1
filters[state]	string		Show only servers in the specified state. The following values are accepted: On, Off, OtherExample: 1
filters[type]	string		Show only servers of the specified type.Example: web
filter[name]	string		Show only servers whose name matches the specified string.Example: examplenz
filters[updated_since]	string		Show only servers that have been modified on or after the specified date. Format is 'YYYY-MM-DD HH:MM:SS'.Example: 2023-01-01 13:30:00
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.3/cloud/server/list_all.json?apikey=your_key_here&client_id=1&filters[state]=1&filters[type]=web&filter[name]=examplenz&filters[updated_since]=2023-01-01+13%3A30%3A00", false);

xmlHttp.send();

var response = xmlHttp.responseText;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.3/cloud/server/list_all.json?apikey=your_key_here&client_id=1&filters[state]=1&filters[type]=web&filter[name]=examplenz&filters[updated_since]=2023-01-01+13%3A30%3A00");
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.3/cloud/server/list_all.json?apikey=your_key_here&client_id=1&filters[state]=1&filters[type]=web&filter[name]=examplenz&filters[updated_since]=2023-01-01+13%3A30%3A00")
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.3/cloud/server/list_all.json?apikey=your_key_here&client_id=1&filters[state]=1&filters[type]=web&filter[name]=examplenz&filters[updated_since]=2023-01-01+13%3A30%3A00'

response = requests.get(uri)

Response

200:

application/json

{
    "return": [
        {
            "id": "31383",
            "client_id": "1",
            "name": "ch-tes123",
            "label": "tes123",
            "state": "On",
            "managed": "1",
            "product_id": "640",
            "created": "2023-01-01 13:00:00",
            "date_updated": "2023-12-01 00:00:00",
            "primary_ip": "192.168.11.58",
            "owner": true
        }
    ],
    "msg": "Successful",
    "status": true
}