SoftLayer Dns Domain ResourceRecord::deleteObject

From SoftLayer Development Network Wiki

deleteObject 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 Error Handling 6 Associated Methods

Overview

Delete a domain's resource record. This cannot be undone. Be wary of running this method. If you remove a resource record in error you will need to re-create it by creating a new SoftLayer_Dns_Domain_ResourceRecord object. The serial number of the domain associated with this resource record is updated upon deletion. You may not delete SOA, NS, or PTR resource records.

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

User Access

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

Return Type

deleteObject returns the boolean data type.

Headers

Required Headers

deleteObject requires the following headers:

• authenticate
• SoftLayer_Dns_Domain_ResourceRecordInitParameters

Error Handling

deleteObject 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 may not be removed." when attempting to remove an NS resource record.

• SoftLayer_Exception

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

Associated Methods

• SoftLayer_Dns_ResourceRecord::deleteObjects