archive/files/{fileid} (DELETE)
Overview
Remove a file from the archive (wipe)
- REST Method: DELETE
- Method Access: public
Uri Parameters
| Name | Type | Description |
| fileid | int | identifies a file by ID |
Query Parameters
| Name | Type | Description |
| authenticate | bool? | Force authentication for request (default: false) |
Return Codes
| Name | Value | Description |
| OK | 200 | Request completed successfully |
| Bad Request | 400 | Invalid input parameter or request body |
| Forbidden | 403 | Administrator access is required |
| Not Found | 404 | Requested file could not be found in the archive |
Message Format
None
Implementation Notes
Removing a file from the archive will cause it to be permanently deleted.
Use archive/files (GET) to retrieve a list of files currently in the archive.
C# Code Samples: Remove File
The following code example removes file with ID 456 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", "456").Delete();
Curl Code Samples: Remove a File
The following command permanently deletes a file (file.archive ID = 1)
Sample Code
curl -u admin:password -X DELETE -i http://mindtouch.address/@api/deki/archive/files/1
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.