Managing Folders

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

get
Get Folder Properties

https://api.couchdrop.io/manage/fileprops
Get all current folder properties.
Request
Response
Request
Query Parameters
token
required
string
Authentication token.
path
optional
string
Folder location.
Response
200: OK
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: Forbidden
Authentication Invalid.
{
"err": "Token was not valid"
}

post
Add/Update Folder Properties

https://api.couchdrop.io/manage/fileprops
Add new or update existing folder properties.
Request
Response
Request
Path Parameters
token
required
string
Authentication Token.
Body Parameters
path
required
string
Folder to apply properties to.
portal_enabled
optional
boolean
Enable web upload portal.
notifications__email
optional
string
Address to send email notifications.
notifications__email_upload
optional
boolean
Send email when files are uploaded.
notifications__email_download
optional
boolean
Send email when files are downloaded.
notifications__email_failures
optional
boolean
Send email when operation fails.
notifications__webhook_upload
optional
boolean
Send webhook when files are uploaded.
notifications__webhook_download
optional
boolean
Send webhook when files are downloaded.
notifications__webhook_failure
optional
boolean
Send webhook when operation fails.
notifications__webhook_uri
optional
string
URI to send webhooks notifications.
advanced_permissions_enabled
optional
boolean
Enable advanced permissions. (Blocks all access to folder by default if enabled.)
Response
200: OK
Successfully updated folder properties.
{}
403: Forbidden
Authentication Invalid.
{
"err": "Token was not valid"
}

‚Äč