getfolderpublink

Name

getfolderpublink

Auth

yes

Description

Creates and returns a public link to a folder.

The folder is identified by folderid or path.

Same optional parameters as getfilepublink.

maxdownloads in this case limits total number of downloads from this folder (even for the same file).

URL

https://api.pcloud.com/getfolderpublink

Required

Parameter	Description
folderid	int folder id of the folder for public link
path	string path to the folder for public link

Use path or folderid

Optional

Parameter	Description
expire	datetime Datetime when the link will stop working
maxdownloads	int Maximum number of downloads from this folder (even for the same file).
maxtraffic	int Maximum traffic that this link will consume (in bytes, started downloads will not be cut to fit in this limit)
shortlink	int If set, a short link will also be generated
linkpassword	string Sets password for the link.

Output

On success returns

Field	Description
linkid	int ID that can be used to delete/modify this public link
code	string link's code that can be used to retrieve the public link contents (with showpublink/getpublinkdownload)

If shortlink is set when calling, additonal

Field	Description
linkid	int ID that can be used to delete/modify this public link
shortcode	string short code that can also be passed to showpublink/getpublinkdownload
shortlink	string a full https link to pc.cd domain with shortcode appended

Example

{
    "result": 0,
    "linkid": Link ID,
    "link": "https:\/\/my.pcloud.com\/#page=publink&code=LinkCode",
    "code": "LinkCode"
}

Errors