API
⚠️ Direct access to the API will be available soon.
| Endpoint | Request type and fields to supply | Description | Response type |
|---|---|---|---|
| /api/storage | GET | Returns information about connected storage servers | servers: String[], locations: String[], hosts: String[], pings: Number[] |
| /api/file | GET | Returns the list of currently protected files and a percentage of storage use | files: File[], percentage: Number |
| /api/file/access | GET - with (query param, me or others) : which way of file access | Return the list of currently shared files (shared with us, or files we shared with others) | files: File[] |
| /api/file/access/modify | POST - mails ({ "mails": [<list of mails>] }): mails of user to change permissions - files ({ "files": [<list of filenames>] }): - permission (add_read or revoke_read): the permission | Change an user access to a file owned by the demanding user | null |
| /api/configuration | GET | Returns a list of information about the configuration | version: String, limit: Number, max_file_size: Number |
| /api/file/protect | POST - threshold (number): number of parts- storage_servers (list): list of storage servers's player name (Charlie1)- file (file): the file to protect | Protects a file | null |
| /api/file/retrieve | POST - name (string): the filename | Retrieves a file | File data as a stream of bytes |
| /api/file/remove | POST - name (string): the filename | Removes a file | null |
| /api/file/multiprotect | POST - threshold (number): threshold in the main proxy- storage_servers (list): list of storage servers's player name (Charlie1) for the main proxy- threshold_secondary (number): threshold for the secondary shares- sub_networks: [[{"proxy_url": "- file (file): the file to protect | Protects a file with the multiss protocol | null |
| /api/file/multiretrieve | POST - name (string): the filename | Retrieves a file protected by multiss | File data as a stream of bytes |
| /api/file/multiremove | POST - name (string): the filename | Removes a file protected by multiss | null |
| /ping | GET | Checks if the proxy is online | null |