archive/files (DELETE)
Overview
Removes all files from the archive (wipe)
- REST Method: DELETE
- Method Access: public
Query Parameters
Name | Type | Description |
authenticate | bool? | Force authentication for request (default: false) |
Return Codes
Name | Value | Description |
OK | 200 | The request completed successfully |
Forbidden | 403 | Administrator access is required |
Message Format
None
Implementation Notes
Removing a file from the archive will cause it to be permanently deleted.
C# Code Sample: Remove All Files
The following code example removes all files from the archive
Sample Code
Plug p = Plug.New("http://deki-hayes/@api/deki"); p.At("users", "authenticate").WithCredentials("admin", "password").Get(); p.At("archive", "files").Delete();
Curl Code Sample:Purge File Archive
The following command permanently deletes all files (namely the files cannot be restored):
Sample Code
curl -u admin:password -X DELETE -i http://mindtouch.address/@api/deki/archive/files
Implementation Notes
curl flags
- -u
- Provides external user authentication.
- -X
- Specifies the HTTP request method.
- -i
- Outputs the HTTP response headers. Useful for debugging.
Permissions
ADMIN permission is required to execute above command.