SoftLayer_Network_Storage::deleteFile

Delete an individual file within a Storage account.

Description

{{CloudLayerOnlyMethod}} Delete an individual file within a Storage account. Depending on the type of Storage account, Deleting a file either deletes the file permanently or sends the file to your account’s recycle bin.

Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the file is in the account’s recycle bin. If the file exist in the recycle bin, then it is permanently deleted.

Please note, a file can not be restored once it is permanently deleted.

Parameters

Required Headers

• Authenticate
• SoftLayer_Network_StorageInitParameters

Optional Headers

• None

Return Values

• boolean

Error Handling

• Throw the error “Not yet implemented for this Storage type.” if the Storage type is not supported.

Associated Methods

• SoftLayer_Network_Storage::deleteFiles
• SoftLayer_Network_Storage::deleteAllFiles
• SoftLayer_Network_Storage::restoreFile
• SoftLayer_Network_Storage::getFilesPendingDelete
• SoftLayer_Network_Storage::getFilePendingDeleteCount

REST Example

curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/deleteFile'