SoftLayer Network Storage Backup Evault::deleteObject

From SoftLayer Development Network Wiki

deleteObject is a member of the SoftLayer_Network_Storage_Backup_Evault service.

Contents 1 Overview 2 Return Type 3 Headers 3.1 Required Headers 4 Error Handling

Overview

Delete a network storage volume. This cannot be undone. At this time only network storage snapshots may be deleted with this method.

deleteObject returns Boolean true on successful deletion or false if it was unable to remove a volume;

Return Type

deleteObject returns the boolean data type.

Headers

Required Headers

deleteObject requires the following headers:

• authenticate
• SoftLayer_Network_Storage_Backup_EvaultInitParameters

Error Handling

deleteObject throws the following exceptions:

• SoftLayer_Exception

Throw the exception "Only snapshots may be deleted with this method." when attempting to remove anything other than a snapshot.