SiteHost API: /cloud/ssh/user/get

/cloud /ssh /user /get

GET https://api.sitehost.nz/1.2/cloud/ssh/user/get.json

Returns information about a SSH user.

Query Parameters

Parameter	Type	Required	Description
client_id	integer	Yes	The ID for the client that the SSH user belongs to.Example: 1
server_name	string	Yes	The server where the SSH user resides.Example: ch-servername
username	string	Yes	The username of the SSH user.Example: sshuser

Code Samples

JavaScript PHP Rails Python

var xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "https://api.sitehost.nz/1.2/cloud/ssh/user/get.json?apikey=your_key_here&client_id=1&server_name=ch-servername&username=sshuser", false);

xmlHttp.send();

var response = xmlHttp.responseText;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.2/cloud/ssh/user/get.json?apikey=your_key_here&client_id=1&server_name=ch-servername&username=sshuser");
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.2/cloud/ssh/user/get.json?apikey=your_key_here&client_id=1&server_name=ch-servername&username=sshuser")
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.2/cloud/ssh/user/get.json?apikey=your_key_here&client_id=1&server_name=ch-servername&username=sshuser'

response = requests.get(uri)

Response

200:

application/json

{
    "return": {
        "username": "ssh-username",
        "server_id": "1",
        "home_dir": "/data/docker0/ssh/ssh-username/home",
        "ssh_keys": [
            {
                "id": "6",
                "label": "bruce",
                "content": "ssh key here"
            }
        ],
        "pending": null,
        "is_missing": "0",
        "date_added": "2023-01-01 00:00:00",
        "date_modified": "2023-01-01 00:00:00",
        "server_label": "ch-myserver",
        "server_owner": true,
        "image": "registry.sitehost.co.nz/sitehost-php7-nginx:latest",
        "containers": [
            "test1nz"
        ],
        "read_only_config": false,
        "volumes": [],
        "ip_addr": "127.0.0.1"
    },
    "msg": "Successful",
    "status": true
}