SiteHost API: /cloud/volume/get

/cloud /volume /get

GET https://api.sitehost.nz/1.3/cloud/volume/get.json

Returns a volume's details.

Query Parameters

Parameter	Type	Required	Description
client_id	integer	Yes	The ID for the client that the volume belongs to.Example: 1
server	string	Yes	The server name for the volume.Example: ch-servername
volume	string	Yes	The volume_nameExample: my-volume

Code Samples

JavaScript PHP Rails Python

var xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "https://api.sitehost.nz/1.3/cloud/volume/get.json?apikey=your_key_here&client_id=1&server=ch-servername&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/volume/get.json?apikey=your_key_here&client_id=1&server=ch-servername&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/volume/get.json?apikey=your_key_here&client_id=1&server=ch-servername&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/volume/get.json?apikey=your_key_here&client_id=1&server=ch-servername&volume=my-volume'

response = requests.get(uri)

Response

200:

application/json

{
    "return": {
        "id": "1",
        "client_id": "1",
        "pending": null,
        "volume_name": "my-volume",
        "is_missing": 0,
        "date_added": "2017-01-01 00:00:00",
        "date_updated": "2017-01-01 00:00:00",
        "server_name": "ch-myserver",
        "server_label": "myserver",
        "server_owner": true,
        "containers": [
        {
            "0": "cc567a321b123c"
        }]
    },
    "msg": "Successful",
    "status": true
}