/cloud/volume/mount


POST https://api.sitehost.nz/1.3/cloud/volume/mount.json

Mounts a volume to a container.

Form Parameters

ParameterTypeRequiredDescription
client_idstringYesThe ID for the client that the volume belongs to.Example: 1
server_namestringYesThe server name for the volume.Example: ch-servername
volume_namestringYesThe name of the volume you're mounting.Example: cc123456789abcde
containers[stack_name][0]stringYesThe name of the containers you're mounting the volume to. You will need to specify the stack when passing in the container name. This parameter accepts one or more values in the format of containers[examplenz][]=x, containers[examplenz][]=y.Example: cc123456789abcde

Code Samples

JavaScript PHP Rails Python 
var xmlHttp = new XMLHttpRequest();
xmlHttp.open("POST", "https://api.sitehost.nz/1.3/cloud/volume/mount.json", false);

var data = new FormData(); 
data.append("apikey", "your_key_here");
data.append("client_id", "1");
data.append("server_name", "ch-servername");
data.append("volume_name", "cc123456789abcde");
data.append("containers[stack_name][0]", "cc123456789abcde");

xmlHttp.send(data);

var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.3/cloud/volume/mount.json");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
$body = array(
    'apikey' => 'your_key_here',
    'client_id' => '1',
    'server_name' => 'ch-servername',
    'volume_name' => 'cc123456789abcde',
    'containers[stack_name][0]' => 'cc123456789abcde',
);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);

$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/mount.json")
http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Post.new(uri.request_uri)

body = {"apikey" => "your_key_here", 
    "client_id" => "1",
    "server_name" => "ch-servername",
    "volume_name" => "cc123456789abcde",
    "containers[stack_name][0]" => "cc123456789abcde",
}
request.set_form_data(body)

response = http.request(request)
import requests
from collections import OrderedDict

uri = 'https://api.sitehost.nz/1.3/cloud/volume/mount.json'

# We need ordered dictionary because parameters have to be in the right order.
# Refer to Developer Notes for more information.
body = OrderedDict()

body['apikey'] = 'your_key_here'
body['client_id'] = '1'
body['server_name'] = 'ch-servername'
body['volume_name'] = 'cc123456789abcde'
body['containers[stack_name][0]'] = 'cc123456789abcde'

response = requests.post(uri, data=body)

Response

200:

application/json
{
  "return": {
    "job_id": "3433562"
  },
  "msg": "Successful",
  "status": true
}