Application Programming Interface

Change Server Hostname


Description:

This function enables you to change a server hostname. The server should be turned off before you change its hostname. Please kindly note that this function will work for server with OS template installation. This function may not work if you install your server with custom ISO, ecspecially non linux OS.

URLs:
  • Sandbox URL: https://virtdedi.com/api-sandbox/v1/change_server_hostname
  • Real API URL: https://virtdedi.com/api/v1/change_server_hostname
Request Parameters:
Parameter Required Type Max Length Description
server_id Yes String 50 characters The ID of server you want to change its hostname.
hostname Yes String 50 characters It should be FQDN (fully qualified domain name).
JSON Response:
    
        
{
    "code"    : "OK",
    "message" : "The server hostname has been changed.",
    "data"    : {
        "server_id" : "12345",
        "hostname"  : "myserver.domain.com"
    }
}
    
XML Response:
    
        
<?xml version="1.0" encoding="utf-8"?>
<code>OK</code>
<message>The server hostname has been changed.</message>
<data>
    <server_id>12345</server_id>
    <hostname>myserver.domain.com</hostname>
</data>
    
PHP Example:
    
        
<?php
$url      = "https://virtdedi.com/api-sandbox/v1/change_server_hostname";
//$url    = "https://virtdedi.com/api/v1/change_server_hostname";
$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",
    "hostname"  => "myserver.domain.com"
);
$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
        }
    }
}