API to delete an asset or it's conversions. Deleting the original is a soft-delete within FileSpin. It will mark Asset as deleted and hide it from view (See Purge API to completely purge an Asset). Asset administrators can retrieve deleted Assets using Search API by setting trashed option to true. Unknown custom keys and keys that do not apply to the file type will be ignored
If an
originalis deleted, all it's conversions will be deleted. If a deletedoriginalis restored, conversions that are enabled in the profile will be re-created.
Request JSON Parameters
| Key | Value | Description |
|---|---|---|
keys | JSON | List of conversion keys. See below for Keys that you can specify |
| Asset/Key type | keys list values |
|---|---|
Image | Built-in keys such as "deepzoom" and/or all the custom conversion keys setup in account settings |
Video | Built-in keys such as "480p-video", "480p-wm-video", "hls-video", "storyboard", etc |
Original | To delete the original asset, use the key “original”. Note this will delete and purge all conversions from storage |
Addon | Addon key defined by the addons deployed |
All Conversions | Use the special key * to delete all conversions |
Webhook callback on delete completion
Once the delete request is completed, callback is issued to configured Webhook.
Please see Tools & Integration- > Webhooks section for file-deleted event callback to learn about the callback JSON structure.
HTTP Response
Standard HTTP Status code - 202 or 200