Developer API Documentation | Hosting & Domain API

The API has been designed to provide an enhanced level of functionality and flexibility to advanced DNS users.

With this system, it is now possible to perform bulk updates, update records without signing into the Sitelutions website, and even create custom applications designed to interact with the Sitelutions DNS system.

The API is constantly under development, and may be prone to updates. However, we will always announce all updates through the site, as well as update the command list located in the API guide above, at the same time as the release. Also bear in mind that any update could issue changes to current functions (such as parameter additions), potentially disrupting services. We will do our best to ensure that this scenario does not happen, and that full backwards-compatibilty is maintained when changes are made. We will also highlight any changes within a changelog in the event that service-impacting modifications become inevitable.

API Access

Gaining access to the API requires a subscription to the Sitelutions Insider's Club with Premium DNS. Unfortunately, this also means that termination of the membership will automatically terminate API access. Luckily, being a member offers many additional benefits; from discounts to increased services to greater support. Visit the club page for more information, and to sign up for API access today.

Resource Locations

https://api.sitelutions.com/soap-api
https://api.sitelutions.com/API

PHP Class (to be used with PHP script below)

<?php
class SitelutionsDNS
{
  private $_user=null;
  private $_pass=null;
  private $_client=null;
  
  
  function SitelutionsDNS($user, $password, $location=null, $uri=null){
    if ($location == null) $location='https://api.sitelutions.com/soap-api';
    if ($uri == null) $uri='https://api.sitelutions.com/API';
    $this->_user=new SoapParam($user, 'user');
    $this->_pass=new SoapParam($password, 'password');
    $this->_client=new SoapClient(null, array('uri'=>$uri, 'location'=>$location));
  }

  function listDomains(){
    $domainList=$this->getArrTable($this->call('listDomains', array()));
    return $domainList;
  }
  
  function addRR($domainid, $data, $type, $hostname, $ttl=null, $aux=null){
    $prm=array('domainid'=>$domainid, 'data'=>$data, 'type'=>$type, 'hostname'=>$hostname);
    if ($ttl != null) $prm['ttl']=$ttl;
    if ($aux != null) $prm['aux']=$aux;
    
    $rr_id=$this->call('addRR', $prm);
    return $rr_id;
  }

  function getDomainByName($name){
    $domain=$this->call('getDomainByName', array('name'=>$name));
    return $this->getObjArr($domain);
  }  

  function getDomainByID($domainid){
    $domain=$this->call('getDomainByID', array('domainid'=>$domainid));
    return $this->getObjArr($domain);    
  }
  

  function listRRsByDomain ($domainid){
    $domainList=$this->getArrTable($this->call('listRRsByDomain', array('domainid'=>$domainid)));
    return $domainList;
    return $rrList;
  }

  
  function getRRByID($rrid){
    $rr=$this->call('getRRByID', array('rrid'=>$rrid));
    return $this->getObjArr($rr);    
  }

  function updateDomain ($domainid, $alertexpire=null, $autorenew=null, $mbox=null, $expire=null, $minimum=null, $ns=null, $serial=null, $retry=null, $refresh=null, $ttl=null){
    $prm['domainid']=$domainid;
    if ($alertexpire != null) $prm['alertexpire']=($alertexpire==true) ? 1:0;
    if ($autorenew != null) $prm['autorenew']=($autorenew==true) ? 1:0;
    if ($mbox != null) $prm['mbox']=$mbox;
    if ($expire != null) $prm['expire']=$expire;
    if ($minimum != null) $prm['minimum']=$minimum;
    if ($ns != null) $prm['ns']=$ns;
    if ($serial != null) $prm['serial']=$serial;
    if ($retry != null) $prm['retry']=$retry;
    if ($refresh != null) $prm['refresh']=$refresh;
    if ($ttl != null) $prm['ttl']=$ttl;
    $this->call('updateDomain',$prm);
    return true;
  }


  function addDomain ($name, $alertexpire=null, $autorenew=null, $mbox=null, $expire=null, $minimum=null, $ns=null, $serial=null, $retry=null, $refresh=null, $ttl=null, $no_default_ns=null){
    $prm['name']=$name;
    if ($alertexpire != null) $prm['alertexpire']=($alertexpire==true) ? 1:0;
    if ($autorenew != null) $prm['autorenew']=($autorenew==true) ? 1:0;
    if ($mbox != null) $prm['mbox']=$mbox;
    if ($expire != null) $prm['expire']=$expire;
    if ($minimum != null) $prm['minimum']=$minimum;
    if ($ns != null) $prm['ns']=$ns;
    if ($serial != null) $prm['serial']=$serial;
    if ($retry != null) $prm['retry']=$retry;
    if ($refresh != null) $prm['refresh']=$refresh;
    if ($ttl != null) $prm['ttl']=$ttl;
    $domainid=$this->call('addDomain', $prm);
    return $domainid;
  }

  function deleteRR($rrid){
    $this->call('deleteRR', array('rrid'=>$rrid));
    return true;
  }

  function deleteDomain($domainid, $confirmation){
    $prm=array('domainid'=>$domainid);
    if ($confirmation) $prm['i_know_all_RRs_for_this_domain_will_be_deleted'] = 1;
    $this->call('deleteDomain', $prm);
    return true;
  }

  function updateRR($rrid, $ttl=null, $data=null, $aux=null){
    $prm['rrid']=$rrid;
    if ($ttl != null) $prm['ttl']=$ttl;
    if ($aux != null) $prm['aux']=$aux;
    if ($data != null) $prm['data']=$data;
    $this->call('updateRR', $prm);
    return true;
  }
  
  private function call($function, $parameters){
    $client=$this->_client;
    $prm=array($this->_user, $this->_pass);
    foreach($parameters AS $name=>$value){
      $prm[]=new SoapParam($value, $name);
    }
    $r = $client->__soapCall($function, $prm);
    return $r;
  }
  
  private function getArrTable($objects){
    foreach ($objects AS $me){
      $x[]=(array) $me;
    }
    return $x;
  }
  
  private function getObjArr($object){
    return (array)$object;
  }

}
?>

PHP Script (to be used with PHP class above)

<html><head><title>Soap API Test</title></head><body>
<?

require_once('sitelutions.class.php');

$sl = new SitelutionsDNS('YOUREMAILADDRESS', 'YOURPASSWORD', 'https://api.sitelutions.com/soap-api','https://api.sitelutions.com/API');

$x=$sl-undefinedgt;listDomains();
tableout($x);
foreach ($x as $domain){
  $y=$sl-undefinedgt;listRRsByDomain($domain['id']);
  echo 'undefinedlt;h3undefinedgt;'.$domain['name'].'undefinedlt;/h3undefinedgt;';
  tableout($y);
}


echo "getDomainByName";
tableout(array($sl-undefinedgt;getDomainByName('YOURDOMAINNAME.TLD')));

echo "getDomainByID";
tableout(array($sl-undefinedgt;getDomainByID(12345)));

$hostname='YOURHOSTNAME';
echo "ADDing RR $hostname";
$newrrid=$sl-undefinedgt;addRR(12345, "1.1.1.1", 'a', $hostname, null, null);

echo "getRRbyID - added in last test added";
tableout(array($sl-undefinedgt;getRRByID($newrrid)));

echo "updateDomain - change ttl";
$sl-undefinedgt;updateDomain(12345, null, null, null, null, null, null, null, null, null, rand(28000,900000));
tableout(array($sl-undefinedgt;getDomainByID(12345)));

echo "addDomain - displayed below";
$newdomainid=$sl-undefinedgt;addDomain ('testdomain'.rand().".net");
tableout(array($sl-undefinedgt;getDomainByID($newdomainid)));

echo "updateRR - recently added RR; random ttl";
$sl-undefinedgt;updateRR($newrrid, rand(28000,90000));

echo "getRRByID - redently added RR";
tableout(array($sl-undefinedgt;getRRByID($newrrid)));

echo "deleteRR - deleting recently added RR";
$sl-undefinedgt;deleteRR($newrrid);

echo "deleteDomain - recently added domain";
$sl-undefinedgt;deleteDomain($newdomainid, true);

function tableout($arr){
  if (count($arr) undefinedlt; 1 OR !is_array($arr) or !is_array($arr[0])) return "";

  echo "undefinedlt;table border=1undefinedgt;undefinedlt;trundefinedgt;\n";
  foreach ($arr[0] AS $name=undefinedgt;$val){
    echo "undefinedlt;thundefinedgt;".ucwords($name)."undefinedlt;/thundefinedgt;";
  }
  echo "undefinedlt;/trundefinedgt;\n";
  foreach ($arr AS $record){
    echo "undefinedlt;trundefinedgt;\n";
    foreach ($record AS $name=undefinedgt;$val){
      echo "undefinedlt;tdundefinedgt;$valundefinedlt;/tdundefinedgt;";
    }
    echo "undefinedlt;/trundefinedgt;\n";
  }
  echo "undefinedlt;/tableundefinedgt;\n";


?>
</body></html>

DNS Update

<?
  # This script updates Dynamic DNS records on Sitelutions
  # (www.sitelutions.com) DNS servers.  
  # You must have php installed on your web server
  # for this script to work.
  #
  # As each domain is updated the response from Sitelutions is 
  # returned for each modification (one response per line)
  # At the time this script was written Sitelutions returns the following:
  #
  # noauth - The user authentication information was incorrect.
  # success - A successful update has been made.
  # failure ([Description]) - Failure occurred, [Description] provides more 
  # information on failure
  #
  # Please see https://www.sitelutions.com/help/dynamic_dns_clients#updatespec
  # for current update specifications.
  #
  #
  # Author: Sitelutions Staff (www.sitelutions.com).
  # Last Modified: 10-February-2003
  #
  # This script is released as public domain in hope that it will
  # be useful to others using Sitelutions and is provided
  # as-is with no warranty implied.  Sending passwords as a part 
  # of an HTTP request is inherently insecure.  
  # Therefore we recommend using HTTPS.  We take no responsibilty
  # if your password is discovered by use of this script.
  #


  # This is a string containing record ID(s) of your Sitelutions A record(s) that you
  # wish to updare.  To obtain this ID, go into the URL undefinedamp; DNS Control Center, click 
  # [Advanced Config] on the appropriate host name, and click the [Dynamic DNS] link
  # next to the A record.  If you do not yet have an A record, create one!
  # Multipel record IDs can be provided using a comma to separate them.
  # If you have multiple records, use something like $aRecordIDs = "99234,423445,234355";

  $aRecordIDs = "99234";
 
 
  $strNewIpAddress = "192.168.10.4";
  $strTTL = "60"; # Default Time-To-Live of 1 minute (60 seconds)
  $strUsername = "your_email@your_domain.com";
  $strPassword = "your_password";

    echo "undefinedlt;h1undefinedgt;Processing DNS Update ............undefinedlt;/h1undefinedgt;";
    $contents = readfile("https://www.sitelutions.com/dnsup?user=".$strUsername."undefinedamp;pass=".$strPassword."undefinedamp;id=".$aRecordIDs."undefinedamp;ip=".$strNewIpAddress."undefinedamp;ttl=".$strTTL);
    echo trim($contents);
    flush();



  
?>

Sitelutions DNS System API Command List

Terms and Conditions

The Sitelutions Application Programming Interface ("SLAPI") is granted only by license. Usage of the SLAPI also automatically confers the user's agreement with the terms listed in this document.undefinednbsp;
As the controlling organization for Sitelutions, InfoRelay Online Systems, Inc. ("InfoRelay") retains the right to change the terms and conditions of the SLAPI at any time. InfoRelay also retains the right to modify functionality and accessibility of the SLAPI at any time.
User access to the SLAPI can be revoked at any time, for any reason, and for any length of time. Reasons include, but are not limited to: termination of membership, excessive or abusive usage, non-payment or other billing issues, or for maintenance reasons.
Use of the SLAPI system is currently activated only in conjunction with a subscription to the Sitelutions Insider's Club Membership with Premium DNS, as one of the benefits of said membership. Expiration or revocation of the membership will also result in the immediate termination of access to the SLAPI system.
The SLAPI can only be modified by Sitelutions, or by InfoRelay and its subsidiaries. We do not provide licenses nor ability for third parties or users to modify, add, or remove functionality from the SLAPI. Modification or attempted modification to the SLAPI by organizations and/or individuals not affiliated with InfoRelay is prohibited.
Neither Sitelutions, InfoRelay, nor any of InfoRelay's subsidiaries are liable to users of the SLAPI system for any damages, whether intentional or unintended, caused by the usage of the SLAPI itself. The SLAPI is provided "as is", although some support will be provided. Provided support will be limited to the two support calls provided by Club Membership, along with five (5) email support tickets per month. In the event that a support ticket escalates from the regular support team to the development team, Sitelutions reserves the right to apply an hourly support rate. The hourly support rate may be variable, and will be determined via the complexity of the problem, as well as the urgency of the matter, among other things. The hourly rate will not be applied to the support ticket without the expressed approval of the user involved in the support ticket itself.
Sitelutions is a subsidiary of InfoRelay, and is the primary entity owned by InfoRelay that may grant the license to use the SLAPI. The license permits an eligible user to utilize our SLAPI system for as long as membership is active and in good standing. Any entity not owned or operated by InfoRelay cannot, and may not, distribute access to the SLAPI system. This document, however, may be distributed freely, but must remain completely unmodified.undefinednbsp;

Usage Guide

The API has been designed to provide an enhanced level of functionality and flexibility to advanced DNS users. With this system, it is now possible to perform bulk updates, update records without signing into the Sitelutions website, and even create custom applications designed to interact with the Sitelutions DNS system.

The API is constantly under development, and may be prone to updates. However, we will always announce all updates through the site, as well as update this command list at the same time as the release. Also bear in mind that any update could issue changes to current functions (such as parameter additions), potentially disrupting services. We will do our best to ensure that this scenario does not happen, and that full backwards-compatibilty is maintained when changes are made. We will also highlight any changes within a changelog in the event that service-impacting modifications become inevitable.

Resource Location:

Endpoint/Location:https://api.sitelutions.com/soap-api

URI/Namespace:https://api.sitelutions.com/API

Example Section:

The SLAPI is a SOAP-based API, and is highly flexible. It is easily adaptable to many different languages, and API access can be implemented using the language of your choice.

The following is a basic "any language" example that must be modified to work with any specific language, be it PHP, Perl, Java, or any other language that is capable of making SOAP calls. The example below is provided as a reference as to how the command and its parameters interact, as well as the expected output format.

Command:

SoapCall("listDomains", user=undefinedgt;"user@email.com", password=undefinedgt;"password");

Output:

{ id=21, domain=undefinedgt;"domain1.com", ttl=undefinedgt;3600, info=undefinedgt;"foo.com" },

{ id=22, domain=undefinedgt;"domain2.com", ttl=undefinedgt;86400, info=undefinedgt;"bar.com" }undefinednbsp;

Command List:

listDomains

Usage	Returns array of hashes containing data elements for each domain.
Parameters	user, password
Optional Parameters	None

addRR

Usage	Simple DNS record addition, defined by domain, hostname, and type of record. Returns the resource record ID on success.
Parameters	user, password, domainid, data, type, hostname
Optional Parameters	ttl, aux
Notes	'hostname' must always be specified, and can be left empty to signify the root domain.

getDomainByName

Usage	Returns hash containing data elements for the domain
Parameters	user, password, name
Optional Parameters	None

getDomainByID

Usage	Returns array of hashes containing data elements for each domain.
Parameters	user, password, domainid
Optional Parameters	None

listRRsByDomain

Usage	Returns array of hashes containing data elements for each resource record.
Parameters	user, password, domainid
Optional Parameters	None

getRRByID

Usage	Returns hash containing data elements for the resource record specified.
Parameters	user, password, rrid
Optional Parameters	Noneundefinednbsp;

updateDomain

Usage	Updates SOA record, along with some Sitelutions-related data, such as automatic renewal preferences and expiration alerts. Returns "Updated" on success.
Parameters	user, password, domainid
Optional Parameters	alertexpire, autorenew, mbox, expire, minimum, ns, serial, retry, refresh, ttl

addDomain

Usage	Easily add a domain, with the option of setting a custom SOA record at the same time. Returns Domain ID on success.
Parameters	user, password, name
Optional Parameters	alertexpire, mbox, expire, minimum, ns, serial, retry, ttl, no_default_ns
Notes	'no_default_ns', if left empty, will use default Sitelutions nameservers for the NS records.

deleteRR

Usage	A simple method of removing a DNS resource record. Returns "Deleted" on success.
Parameters	name, password, rrid
Optional Parameters	None

deleteDomain

Usage	Deletes an already existing domain in the account, with minor confirmation. Returns "Deleted" on success.
Parameters	user, password, domainid, i_know_all_RRs_for_this_domain_will_be_deleted
Optional Parameters	None
Notes	'i_know_all_RRs_for_this_domain_will_be_deleted' is mainly only used as a disclaimer. Deleting the domain will require that this field be set to some non-zero value.undefinednbsp;

updateRR

Usage	Updates previously created DNS resource record. Returns "Updated" on success.
Parameters	user, password, rrid
Optional Parameters	ttl, data, aux
Notes	This function only updates fields that are sent.undefinednbsp;

Launch your website today

Create your digital presence today, fast, easy and completely risk-free with our money back guarantee.

Get Hosting Register A Domain

Sitelutions DNS API

The API has been designed to provide an enhanced level of functionality and flexibility to advanced DNS users.

API Access

Resource Locations

PHP Class (to be used with PHP script below)

PHP Script (to be used with PHP class above)

DNS Update

Sitelutions DNS System API Command List

Terms and Conditions

Usage Guide

Command List:

Launch your website today

Hosting

Domains

Account

Company

Sitelutions DNS API

The API has been designed to provide an enhanced level of functionality and flexibility to advanced DNS users.

API Access

Resource Locations

PHP Class (to be used with PHP script below)

PHP Script (to be used with PHP class above)

DNS Update

Sitelutions DNS System API Command List

Terms and Conditions

Usage Guide

Command List:

Launch your website today

Hosting

Domains

Account

Company

Generate Password