/server/snapshot/create


POST https://api.sitehost.nz/1.3/server/snapshot/create.json

Creates a snapshot from a disk

Form Parameters

ParameterTypeRequiredDescription
client_idintegerYesThe ID for the client.Example: 1
namestringYesThe name of the server.Example: servername
partitionstringYesThe name of the disk to snapshot.Example: xvda2
lifetimeintegerThe lifetime in hours that the snapshot should be valid for. This can be between 1 and 24 hours.Example: 1

Code Samples

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

var data = new FormData();
data.append("apikey", "your_key_here");
data.append("client_id", "1");
data.append("name", "servername");
data.append("partition", "xvda2");
data.append("lifetime", "1");

xmlHttp.send(data);

var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.3/server/snapshot/create.json");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
$body = array(
'apikey' => 'your_key_here',
'client_id' => 1,
'name' => 'servername',
'partition' => 'xvda2',
'lifetime' => 1,
);
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/server/snapshot/create.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,
"name" => "servername",
"partition" => "xvda2",
"lifetime" => 1,
}
request.set_form_data(body)

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

uri = 'https://api.sitehost.nz/1.3/server/snapshot/create.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['name'] = 'servername'
body['partition'] = 'xvda2'
body['lifetime'] = 1

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

Response

200:

application/json
{
  "return": {
    "job_id": "29",
    "snapshot_id": "93"
  },
  "msg": "Successful",
  "status": true
}