Introduction

Get Arch List

Get OS Variant List

Get OS Template List

Get Server List

Get Server Detail

Create Server

Cancel Server

Reinstall Server

Turn Server On

Turn Server Off

Change Server Label

Change Server Hostname

Change Reverse Host

Set Server Custom Info

Change Server Password

Get Server Virtual Monitor URL

Get Server Shared Access List

Add Server Shared Access

Delete Server Shared Access

Get Snapshot List

Get Snapshot Detail

Delete Snapshot

Set Server Snapshot Schedule

Set Server Snapshot Schedule

Description:

This function enables you to set schedule for creating server snapshot.

URLs:

• Sandbox URL: https://virtdedi.com/api-sandbox/v1/set_server_snapshot_schedule
• Real API URL: https://virtdedi.com/api/v1/set_server_snapshot_schedule

Request Parameters:

Parameter	Required	Type	Max Length	Description
server_id	Yes	String	50 characters	The ID of server.
daily_backup	No	String	5 characters	Available options: yes no (default)
daily_backup_max_age	Conditional	Integer (days)	2 digits	The days you want to retain the daily backup files. This parameter is required if "daily_backup" value is "yes". Minimum value: 1
weekly_backup	No	String	5 characters	Available options: yes no (default)
weekly_backup_max_age	Conditional	Integer (weeks)	2 digits	The weeks you want to retain the weekly backup files. This parameter is required if "weekly_backup" value is "yes". Minimum value: 1
monthly_backup	No	String	5 characters	Available options: yes no (default)
monthly_backup_max_age	Conditional	Integer (months)	2 digits	The months you want to retain the monthly backup files. This parameter is required if "monthly_backup" value is "yes". Minimum value: 1

JSON Response:

    
        
{
    "code"    : "OK",
    "message" : "The server snapshot schedule has been set.",
    "data"    : {
        "server_id"                : "12345",
        "daily_snapshot"           : "yes",
        "daily_snapshot_max_age"   : 7,
        "weekly_snapshot"          : "no",
        "weekly_snapshot_max_age"  : 0,
        "monthly_snapshot"         : "no",
        "monthly_snapshot_max_age" : 0
    }
}
    

XML Response:

    
        
<?xml version="1.0" encoding="utf-8"?>
<code>OK</code>
<message>The server snapshot schedule has been set.</message>
<data>
    <server_id>12345</server_id>
    <daily_snapshot>yes</daily_snapshot>
    <daily_snapshot_max_age>7</daily_snapshot_max_age>
    <weekly_snapshot>no</weekly_snapshot>
    <weekly_snapshot_max_age>0</weekly_snapshot_max_age>
    <monthly_snapshot>no</monthly_snapshot>
    <monthly_snapshot_max_age>0</monthly_snapshot_max_age>
</data>
    

PHP Example:

    
        
<?php
$url      = "https://virtdedi.com/api-sandbox/v1/set_server_snapshot_schedule";
//$url    = "https://virtdedi.com/api/v1/set_server_snapshot_schedule";
$user_id  = "12312";
$API_key  = "hasdh6ghvhgFDa454565jasdbNBS";
$random   = rand(10000,99999).uniqid().rand(100000,999999);
$checksum = sha1(sha1(sha1($user_id.$API_key.$random)));
$data = array(
    "user_id"                  => $user_id,
    "random"                   => $random,
    "format"                   => "json",
    "checksum"                 => $checksum,
    "server_id"                => "12345",
    "daily_snapshot"           => "yes",
    "daily_snapshot_max_age"   => 7,
    "weekly_snapshot"          => "no",
    "weekly_snapshot_max_age"  => 0,
    "monthly_snapshot"         => "no",
    "monthly_snapshot_max_age" => 0
);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, 20);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
$output = curl_exec($ch);
$curl_error = curl_errno($ch);
curl_close($ch);
if ($curl_error){
    echo "Unable to connect to API Server.";
} else {
    $outputArray = json_decode($output,true);
    if (!$outputArray){
        echo "Invalid JSON Format";
    } else {
        if ($outputArray["code"] == "OK"){
            print_r($outputArray);
            // Do what you want to do here if OK
        } else {
            echo "Error Message: ".$outputArray["message"];
            // Do what you want to do here if not OK
        }
    }
}