🛡️ Deindex one or more of your files.
Deindexes one or more files. To "deindex" means to delete the file entity and all of its derived entities like songs and episodes, and all of their derived entities like metadata and thumbnails.
Deindexing however does not delete cached static resources on the disk like the thumbnail files that the server generates when initially indexing things. Those now stale assets will eventually be deleted by a cleanup cron job.
If a wildcard (*) is given as the sole item in the array, all files will be deindexed. The wildcard method only supports hard deleting, so you must also set hardDelete to true to activate it. Only a true boolean will be returned when the wildcard operation is done.
By default, this deindexing is a soft delete. To perform a hard delete, set the hardDelete param to true.
<!-- Leave this line empty --><br /><hr /><h3>🛡️ Requires Capabilities: <code>Indexing.Deindex</code></h3>
Query parameters
Response
Returns an object of file IDs and booleans, indicating whether each file was successfully deindexed.
Example response
{
"7b74fae5-c377-4352-983d-0981e9b9fbec": true
}