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

Cancel Server

Description:

This function enables you to cancel a server subscription.

URLs:

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

Request Parameters:

Parameter	Required	Type	Max Length	Description
server_id	Yes	String	50 characters	The ID of server you want to delete.
retain_snapshot_files	No	String	3 characters	Available options: yes no (default)

JSON Response:

    
        
{
    "code"    : "OK",
    "message" : "The server subscription has been canceled. The server will be permanently deleted.",
    "data"    : {
        "server_id" : "12345"
    }
}
    

XML Response:

    
        
<?xml version="1.0" encoding="utf-8"?>
<code>OK</code>
<message>The server subscription has been canceled. The server will be permanently deleted.</message>
<data>
    <server_id>12345</server_id>
</data>
    

PHP Example:

    
        
<?php
$url      = "https://virtdedi.com/api-sandbox/v1/cancel_server";
//$url    = "https://virtdedi.com/api/v1/cancel_server";
$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"
);
$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
        }
    }
}