SoftLayer Network Storage::deleteObject

From SoftLayer Development Network Wiki

deleteObject is a member of the SoftLayer_Network_Storage service.

Contents 1 Overview 2 User Access 3 Return Type 4 Headers 4.1 Required Headers 5 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;

User Access

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

Return Type

deleteObject returns the boolean data type.

Headers

Required Headers

deleteObject requires the following headers:

• authenticate
• SoftLayer_Network_StorageInitParameters

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.