Shared Links

Shared Links can be created to provide external users with access to files. Links can be set up securely with a password requirement as well as a time for access via the link to expire.

Get Shared Links

GET https://api.couchdrop.io/manage/sharedlinks

Headers

Name	Type	Description
token	string	API Access Token

200 Returns list of shared links

{
  "result": [
              {"account": "admin",
                "expiry": 86400,
                "id": "94a4235b-c4ae-4ded-b31a-c7d0e29844b9",
                "password": "P@ssw0rd",
                "path": "/google/folder1"},
              {"account": "admin",
                "expiry": 0,
                "id": "a6f1cd25-bba2-453f-b9cd-d369c6ce5693",
                "password": "",
                "path": "/onedrive/accounts.pdf"}
             ]
 }

Add Shared Link

PUT https://api.couchdrop.io/manage/sharedlinks

Headers

Name	Type	Description
token	string	API Access Token

200 Returns newly created shared link object

{
    "result": {
             "account": "admin",
             "expiry": 0,
             "id": "e2a460ed-af5b-4af4-bcf5-c07accab8dde",
             "password": "",
             "path": "/"
             }
}

Update Shared Link

POST https://api.couchdrop.io/manage/sharedlinks

Headers

Name	Type	Description
token	string	API Access Token

Request Body

Name	Type	Description
id	string	Shared link identifier, generated by the system
expiry	string	Expiration time for shared link (epoch time ie: '1606087502')
password	string	Password to protect shared link
path	string	Path to file / folder that will be shared

200

{}

Delete Shared Link

DELETE https://api.couchdrop.io/manage/sharedlinks/<link_id>

Path Parameters

Name	Type	Description
link_id	string	ID of shared link to be deleted

Headers

Name	Type	Description
token	string	API Access Token

200

{}