SiteHost API: /cloud/stack/list

/cloud /stack /list_all

GET https://api.sitehost.nz/1.0/cloud/stack/list_all.json

Returns a list of all stacks.

Query Parameters

Parameter	Type	Required	Description
client_id	integer	Yes	The ID for the client that the stacks belong to.Example: 1
filters[server_name]	string		Show only stacks residing on a specific server.Example: ch-servername
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/cloud/stack/list_all.json?apikey=your_key_here&client_id=1&filters[server_name]=ch-servername", false);

xmlHttp.send();

var response = xmlHttp.responseText;

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

response = requests.get(uri)

Response

200:

application/json

{
    "return": {
        "total_items": 2,
        "current_items": 2,
        "current_page": 1,
        "total_pages": 1,
        "data": [
            {
                "client_id": "1",
                "server_id": "31462",
                "name": "test1nz",
                "label": "test1.nz",
                "docker_file": "docker file contents",
                "date_created": "2016-04-20 11:57:53",
                "pending": null,
                "is_missing": "0",
                "server_name": "ch-mycloud",
                "server_label": "My Cloud",
                "server_owner": true,
                "containers": [
                    {
                        "name": "test1.nz",
                        "container_id": "58ae138422f1e92f9d5f0fe6a886f8666374a4024cee66369183f63e60ec0d7f",
                        "state": "Up",
                        "size": "265096",
                        "date_created": "2016-04-20 11:57:53",
                        "pending": null,
                        "is_missing": "0",
                        "ssl_enabled": false
                    }
                ],
                "ip_addr_server": "192.168.11.152"
            },
            {
                "client_id": "1",
                "server_id": "31462",
                "name": "test2nz",
                "label": "test2.nz",
                "docker_file": "docker file contents",
                "date_created": "2016-04-20 11:57:53",
                "pending": null,
                "is_missing": "0",
                "server_name": "ch-mycloud",
                "server_label": "My Cloud",
                "server_owner": true,
                "containers": [
                    {
                        "name": "test2.nz",
                        "container_id": "f7d0ce06e36f38196366eec4204a4736668f688a6ef0f5d9f29e1f224831ea85",
                        "state": "Up",
                        "size": "265096",
                        "date_created": "2016-04-20 11:57:53",
                        "pending": null,
                        "is_missing": "0",
                        "ssl_enabled": false
                    }
                ],
                "ip_addr_server": "192.168.11.152"
            }
        ]
    },
    "msg": "Successful",
    "status": true
}