Application Programming Interface

Change Server Label


Description:

This function enables you to change a server label.

URLs:
  • Sandbox URL: https://virtdedi.com/api-sandbox/v1/change_server_label
  • Real API URL: https://virtdedi.com/api/v1/change_server_label
Request Parameters:
Parameter Required Type Max Length Description
server_id Yes String 50 characters The ID of server you want to change its label.
server_label Yes String 50 characters The new server label.
JSON Response:
    
        
{
    "code"    : "OK",
    "message" : "The server label has been changed.",
    "data"    : {
        "server_id"    : "12345",
        "server_label" : "My Server Label"
    }
}
    
XML Response:
    
        
<?xml version="1.0" encoding="utf-8"?>
<code>OK</code>
<message>The server label has been changed.</message>
<data>
    <server_id>12345</server_id>
    <server_id>My Server Label</server_id>
</data>
    
PHP Example:
    
        
<?php
$url      = "https://virtdedi.com/api-sandbox/v1/change_server_label";
//$url    = "https://virtdedi.com/api/v1/change_server_label";
$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",
    "server_label" => "My Server Label"
);
$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
        }
    }
}