SoftLayer Dns Domain ResourceRecord::deleteObjects

From SoftLayer Development Network Wiki

deleteObjects is a member of the SoftLayer_Dns_Domain_ResourceRecord service.

Contents 1 Overview 2 User Access 3 Return Type 4 Headers 4.1 Required Headers 5 Parameters 5.1 templateObjects 6 Error Handling 7 Associated Methods

Overview

Remove multiple resource records from a domain. This follows the same logic as deleteObject and cannot be undone. The serial number of the domain associated with this resource record is updated upon deletion. You may not delete SOA records, PTR records, or NS resource records that point to ns1.softlayer.com or ns2.softlayer.com.

deleteObjects returns Boolean true on successful deletion or false if it was unable to remove a resource record.

User Access

Users wishing to execute deleteObjects service must have the Manage DNS permission assigned to their account.

Return Type

deleteObjects returns the boolean data type.

Headers

Required Headers

deleteObjects requires the following headers:

• authenticate

Parameters

deleteObjects takes the following parameters:

templateObjects

An array of skeleton SoftLayer_Dns_Domain_ResourceRecord objects that you wish to delete. Each object in the array must have at least their id properties defined.

• Type: SoftLayer_Dns_Domain_ResourceRecordArray

Error Handling

deleteObjects throws the following exceptions:

• SoftLayer_Exception

Throw the exception "SOA records may not be removed." when attempting to remove an SOA resource record.

• SoftLayer_Exception

Throw the exception "NS records for ns1.softlayer.com or ns2.softlayer.com may not be removed." when attempting to remove an NS resource record that points to ns1.softlayer.com or ns2.softlayer.com.

• SoftLayer_Exception

Throw the exception "PTR records may not be removed." when attempting to remove a PTR resource record.

Associated Methods

• SoftLayer_Dns_ResourceRecord::deleteObject