DNS API

List domains

A list of all domains that are hosted on the IBM Cloud name servers can be retrieved with SoftLayer_Account::getDomains returns an array of SoftLayer_Dns_Domain template objects. You can extend this call to also pull the records that are associated with these domains by using an object mask.

$client = SoftLayer_SoapClient::getClient('SoftLayer_Account', null, $apiUser, $apiKey);
$objectMask = "mask.resourceRecords";
$client->setObjectMask($objectMask);
$domains = $client->getDomains();
print_r($domains);

Create domains

To create a new zone, a SoftLayer_Dns_Domain template object must be created and passed into SoftLayer_Dns_Domain::createObject. NS records for ns1.softlayer.com and ns2.softlayer.com are automatically added during creation. Include at least one A or AAAA record with the template object for successful creation. The API adds or updates the Domain serial numbers. You do not need to include the serial numbers in the template object.

The following properties are necessary when you create a SoftLayer_Dns_Domain object.

• name: Domain name, which includes the TDL
• resourceRecords: An array of at least one SoftLayer_Dns_Domain_ResourceRecord

$client = SoftLayer_SoapClient::getClient('SoftLayer_Dns_Domain', null, $apiUser, $apiKey);
$template = new stdClass();
$template->name = "createexample.com";
$template->resourceRecords = array();
$template->resourceRecords[0] = new stdClass();
$template->resourceRecords[0]->data = '127.0.0.1';
$template->resourceRecords[0]->host = 'server1';
$template->resourceRecords[0]->type = 'a';
$result = $client->createObject($template);
print_r($result);

SoftLayer_Dns_Domain::createObject Returns a fully populated SoftLayer_Dns_Domain object.

Edit domains

Modifying existing SoftLayer_Dns_Domain entries is not possible. Changes to zone names should be refactored to the creation of new zones.

Delete domains

Removal of a zone is accomplished with SoftLayer_Dns_Domain::deleteObject. This method requires only an init parameter to be provided.

$domainId = 1545925;
 
$client = SoftLayer_SoapClient::getClient('SoftLayer_Dns_Domain', $domainId, $apiUser, $apiKey);
 
$result = $client->deleteObject();
print_r($result);

SoftLayer_Dns_Domain::deleteObject Returns a Boolean value: true for successful, false for failed.

List records

In addition to the method mentioned, domain resource records can be retrieved with SoftLayer_Dns_Domain::getResourceRecords, which returns an array of SoftLayer_Dns_DomainResourceRecord objects.

$domainId = 12345;
$client = SoftLayer_SoapClient::getClient('SoftLayer_Dns_Domain', $domainId, $apiUser, $apiKey);
 
$result = $client->getResourceRecords();
print_r($result);

Create records

Creating records directly through the SoftLayer_Dns_Domain_ResourceRecord service is accomplished by creating a SoftLayer_Dns_Domain_ResourceRecord template object and passing it into SoftLayer_Dns_Domain_ResourceRecord::createObject. The use of @ in the host property denotes a wildcard hostname.

The IBM Cloud DNS system supports these record types:

• a
• aaaa
• cname
• mx
• ns
• ptr
• soa
• spf
• srv
• txt

At minimum, the template object must contain:

• data: Value of the record
• host: Label to be added under the zone

$client = SoftLayer_SoapClient::getClient('SoftLayer_Dns_Domain_ResourceRecord', null, $apiUser, $apiKey);
$domainId = 123456;
 
$template = new stdClass();
$template->data = 'webserver01.example.com';
$template->host = 'www';
$template->type = 'cname';
$template->domainId = $domainId;
 
$result = $client->createObject($template);
print_r($result);

Edit records

Edit resource records by passing a template object into SoftLayer_Dns_Domain_ResourceRecord::editObject. The template object must contain:

• ID: Identifier for the SoftLayer_Dns_Domain_ResourceRecord to be edited.
• domainId: Identifier of the SoftLayer_Dns_Domain to which this resource record is a child record
• properties: To be changed

The API updates the Domain serial numbers automatically.

$domainId = 45567;
$resourceRecordId = 1234;
$client = SoftLayer_SoapClient::getClient('SoftLayer_Dns_Domain_ResourceRecord', $resourceRecordId, $apiUser, $apiKey);
 
$template = new stdClass();
$template->id = $resourceRecordId;
$template->domainId = $domainId;
$template->data = '127.0.0.1';
$template->host = 'server01';
 
$result = $client->editObject($template);
print_r($result);

It is also necessary to populate the init params with the resource record ID property. SoftLayer_Dns_Domain_ResourceRecord::editObject returns a Boolean value.

Delete records

Removal of a record is accomplished with SoftLayer_Dns_Domain_ResourceRecord::deleteObject. This method requires only an init parameter to be provided.

$recordId = 1545925;
 
$client = SoftLayer_SoapClient::getClient('SoftLayer_Dns_Domain_ResourceRecord', $recordId, $apiUser, $apiKey);
 
$result = $client->deleteObject();
print_r($result);

SoftLayer_Dns_Domain_ResourceRecord::deleteObject Returns a Boolean value: true for successful, false for failed.