Folder Properties

With Couchdrop you can configure folders with advanced user permissions, webhook and email notifications, as well as web portal uploads.

Folder Properties

Get folder properties

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

Get all current folder properties.

Query Parameters

Name	Type	Description
path	string	Path to file / folder

Headers

Name	Type	Description
token	string	API Access Token

200 Successfully retrieved folder properties

{"result": {"account": "test",
             "advanced_permissions_enabled": False,
             "email_upload_address": "[email protected]",
             "email_upload_enabled": True,
             "id": "12b7c994-bd45-4dd4-b02b-2f13248deba5",
             "notifications__email": "[email protected]",
             "notifications__email_download": False,
             "notifications__email_failures": False,
             "notifications__email_upload": False,
             "notifications__webhook_download": False,
             "notifications__webhook_failure": False,
             "notifications__webhook_upload": False,
             "notifications__webhook_uri": "",
             "path": "/mount0",
             "portal_enabled": False,
             "portal_url": "https://upload.couchdrop.io/2d769df4-08a7-4ff3-a166-831229363281"}}

403 Authentication Invalid.

{
  "err": "Token was not valid"
}

Add/Update folder properties

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

Add new or update existing folder properties.

Headers

Name	Type	Description
token	string	API Access Token

Request Body

Name	Type	Description
path	string	Folder to apply properties to.
portal_enabled	boolean	Enable web upload portal.
notifications__email	string	Address to send email notifications.
notifications__email_upload	boolean	Send email when files are uploaded.
notifications__email_download	boolean	Send email when files are downloaded.
notifications__email_failures	boolean	Send email when operation fails.
notifications__webhook_upload	boolean	Send webhook when files are uploaded.
notifications__webhook_download	boolean	Send webhook when files are downloaded.
notifications__webhook_failure	boolean	Send webhook when operation fails.
notifications__webhook_uri	string	URI to send webhooks notifications.
advanced_permissions_enabled	boolean	Enable advanced permissions. (Blocks all access to folder by default if enabled.)

200 Successfully updated folder properties.

{}

403 Authentication Invalid.

{
  "err": "Token was not valid"
}