Documentation Index

Fetch the complete documentation index at: https://help.12dsynergy.com/llms.txt

Use this file to discover all available pages before exploring further.

Purge a File

Prev Next

This tutorial demonstrates how to purge a file by ID via the RESTful API.

Purging a file means removing the file permanently.

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.)

1.1. Getting the Personal Access Token to access API

The tutorial for getting the PAT is here: Generate PAT in Web client.

1.2. Purging a File using the File ID

This request is in the API documentation under Files, marked 'Purge a file (delete a file permanently)'.

Sample Request

curl --location 'http://synergy.myserver.com/api/v1/files/{file-id-here}/purge' \

--header 'Authorization: Bearer <token-here>' \

--header 'Content-Type: application/json'

Below is a sample response when purging a file.

Sample Response

true