You will need an API Key ID and API Key Secret to use this API. This API is for retrieving the settings for a single file.


  1. Require basic authentications
  2. base64 encoded version of <ID>:<Secret>

Sample Request 


Connection: keep-alive
Accept: application/json, text/plain, */*
Authorization: Basic amFccGVyX1Rdfsdsb1BlcjoxMjM0NTZhYmNkZYY=
Content-Type: application/x-www-form-urlencoded
Accept-Encoding: gzip, deflate, br
Accept-Language: en-US,en;q=0.8,zh-CN;q=0.6,zh-TW;q=0.4

Sample Response

HTTP/1.1 200 Successfully returned file settings
Content-Length: 692
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/8.0
X-Powered-By: ASP.NET
Date: Wed, 23 Oct 2019 03:48:17 GMT

  "FileSettings": {
    "Guid": "903ebafcdd7b4c2592aeccd4795a6d88",
    "Link": "",
    "FileName": "Secret.pdf",
    "FileCreatedTime": "2019-10-17T01:24:43.506Z",
    "FileStatus": "Active",
    "TotalViewedCount": 1,
    "Permission": "Restrict",
    "RequestEmail": false,
    "Recipients": null,
    "RestrictForwarding": true,
    "Download": 0,
    "Print": 0,
    "Secret": false,
    "Watermark": false,
    "Watermark_text": null,
    "Watermark_size": null,
    "Watermark_color": null,
    "MovableWatermark": false,
    "Expiry": "off",
    "DestructSeconds": 0,
    "ExpiryDate": "0001-01-01T00:00:00"
  "Status": {
    "StatusCode": 20000,
    "StatusMessage": "Successfully returned file settings"
Did this answer your question?