Weblink Objects#

Weblink URLs

Weblinks can be pointed at a directory or a single file. The url can be constructed link this:

https://portal.cloudplan.net/wl/<NAME>/<ID>

With the properties

NAME: The name of the file or directory, urlencoded or special characters removed
ID: The weblink_id from the weblink object below

JSON Object Full Example

Here is an example for a weblink object as used by the API in several places.

{
    "weblink_id": "6960E43D3610891AC92D138394C33666",
    "folder_id": "6960D3994737607552574B980961708E",
    "file_id": "6960E107DEC531B66786291E130EFA38",
    "approved": true,
    "needs_approval": false,
    "views": 1,
    "max_downloads": 10,
    "downloads": 1,
    "valid_until": 1770549565,
    "created": 1767957565,
    "creator_id": "56A23B5444D384B805785604C517C14B",
    "permissions": "read",
    "protected": true
}

Properties

weblink_id

Id of the weblink, used for managing or accessing it.

folder_id

Id of the folder where it links to or where the file is contained.

file_id

If of the file that can be downloaded with this link.

approved

Links may be approved, this indicates the approval status.

needs_approval

Indicates whether approval is required after creation of the weblink.

views

The number of times the link has been opened/viewed.

max_downloads

The maximum number of times the file can be downloaded with this link.

downloads

The number of times this file has been downloaded so far.

valid_until

The link is valid until this unix timestamp runs out.

created

The creation timestamp of the link.

creator_id

User ID of the creator of the link.

permissions

Indicates which permissions are granted to the file. Possible values are:

“read”
“write”
“delete”

protected

Indicates whether the link is password protected or not.