SiteHost API: /cloud/ssh/user/list

/cloud /ssh /user /list_all

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

Returns a list of all SSH users.

Query Parameters

Parameter	Type	Required	Description
client_id	integer	Yes	The ID for the client that the SSH users belong to.Example: 1
filters[server_name]	string		Show only users that reside on the specified server.Example: ch-servername
filters[username]	string		Show only users whose name matches the specified string.Example: sshuser
filters[container]	string		Show only users linked to the specified container.Example: example.nz
filters[volume]	string		Show only users linked to the specified volume.Example: my-volume
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/ssh/user/list_all.json?apikey=your_key_here&client_id=1&filters[server_name]=ch-servername&filters[username]=sshuser&filters[container]=example.nz&filters[volume]=my-volume", false);

xmlHttp.send();

var response = xmlHttp.responseText;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.3/cloud/ssh/user/list_all.json?apikey=your_key_here&client_id=1&filters[server_name]=ch-servername&filters[username]=sshuser&filters[container]=example.nz&filters[volume]=my-volume");
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/ssh/user/list_all.json?apikey=your_key_here&client_id=1&filters[server_name]=ch-servername&filters[username]=sshuser&filters[container]=example.nz&filters[volume]=my-volume")
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/ssh/user/list_all.json?apikey=your_key_here&client_id=1&filters[server_name]=ch-servername&filters[username]=sshuser&filters[container]=example.nz&filters[volume]=my-volume'

response = requests.get(uri)

Response

200:

application/json

{
    "return": {
        "total_items": 2,
        "current_items": 2,
        "current_page": 1,
        "total_pages": 1,
        "data": [
            {
                "username": "ssh-username",
                "server_id": "1",
                "client_id":  "1",
                "home_dir": "/data/docker0/ssh/ssh-username",
                "ssh_keys": [
                    {
                        "id": "6",
                        "label": "bruce",
                        "content": "ssh key here"
                    }
                ],
                "pending": null,
                "is_missing": 0,
                "date_added": "2019-01-01 00:00:00",
                "date_updated": "2019-01-01 00:00:00",
                "server_name": "ch-myserver",
                "server_label": "myserver",
                "server_owner": true,
                "image": "registry.sitehost.co.nz/php7.4",
                "containers": [
                    {
                        "cc567a321b123c"
                    }
                ],
                "read_only_config": false,
                "volumes": [],
                "ip_addr": "192.168.1.1"
            },
            {
                "username": "another-ssh-username",
                "server_id": "1",
                "client_id":  "1",
                "home_dir": "/data/docker0/ssh/another-ssh-username",
                "ssh_keys": [
                    {
                        "id": "6",
                        "label": "bruce",
                        "content": "ssh key here"
                    }
                ],
                "pending": null,
                "is_missing": 0,
                "date_added": "2019-01-01 00:00:00",
                "date_updated": "2019-01-01 00:00:00",
                "server_name": "ch-myserver",
                "server_label": "myserver",
                "server_owner": true,
                "image": "registry.sitehost.co.nz/php7.4",
                "containers": [
                    {
                        "cc567a321b123c"
                    }
                ],
                "read_only_config": false,
                "volumes": [],
                "ip_addr": "192.168.1.1"
            }
        ]
    },
    "msg": "Successful",
    "status": true
}