SiteHost API: /server/get

/server /get_state

GET https://api.sitehost.nz/1.3/server/get_state.json

Retrieves the state of a server.

Query Parameters

Parameter	Type	Required	Description
client_id	integer	Yes	The ID for the client that the server belongs to.Example: 1
name	string	Yes	The name of the server.Example: servername

Code Samples

JavaScript PHP Rails Python

var xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "https://api.sitehost.nz/1.3/server/get_state.json?apikey=your_key_here&client_id=1&name=servername", false);

xmlHttp.send();

var response = xmlHttp.responseText;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.3/server/get_state.json?apikey=your_key_here&client_id=1&name=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.3/server/get_state.json?apikey=your_key_here&client_id=1&name=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.3/server/get_state.json?apikey=your_key_here&client_id=1&name=servername'

response = requests.get(uri)

Response

200:

application/json

{
  "return": {
    "state": "On",
    "rescue": false
  },
  "msg": "Successful",
  "status": true
}