This tutorial demonstrates how to delete a file by ID via the RESTful API.
The steps include:
Delete a file using the file ID
Additional API documentation
To get a list of most of the API requests available, with the 12d Synergy server running, browse http://synergy.myserver.com/api-docs/ui/index.
(Replace synergy.myserver.com with the external server address and update the port numbers if necessary.)
Getting the Personal Access Token to access API
The tutorial for getting the PAT is here: Generate PAT in Web client.
1.2. Deleting a file using the file ID
This request can be found in the API documentation under Files marked 'Delete a file (mark file as deleted)'.
Sample Request
curl --location 'http://{your-server-here}/api/v1/files/delete' \
--header 'Authorization: Bearer <token-here>' \
--header 'Content-Type: application/json' \
--data '{
"id": {
"_id": 170158,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "170158_1"
},
"description": "string"
}'Below is a sample response when deleting a file.
Sample Response
true