/cloud/volume/add
POST https://api.sitehost.nz/1.3/cloud/volume/add.json
Creates a volume.
Form Parameters
Parameter | Type | Required | Description |
client_id | string | Yes | The ID for the client that the volume will belong to.Example: 1 |
server_name | string | Yes | The server that the volume will be created on.Example: ch-servername |
volume_name | string | Yes | The name for the new volume.Example: my-volume |
container_names[0] | string | The list of containers to add the volume to.Example: cc123456789abcde |
Code Samples
JavaScript PHP Rails Pythonvar xmlHttp = new XMLHttpRequest();
xmlHttp.open("POST", "https://api.sitehost.nz/1.3/cloud/volume/add.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", "my-volume");
data.append("container_names[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/add.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' => 'my-volume',
'container_names[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/add.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" => "my-volume",
"container_names[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/add.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'] = 'my-volume'
body['container_names[0]'] = 'cc123456789abcde'
response = requests.post(uri, data=body)
Response
200:application/json
{
"return": {
"job_id": "3433562"
},
"msg": "Successful",
"status": true
}
"return": {
"job_id": "3433562"
},
"msg": "Successful",
"status": true
}