Create share link

post

https://{server}/api/v2.1/share-links/

Create a download share link for a file, folder or library. Only one link per user and item can be created with this endpoint (use Create multi share links for additional links).

Links cannot be created for encrypted libraries.
With only read permission on the item, only preview/download links are possible; can_upload requires read-write permission; users with preview/cloud-edit permission can only create preview-only links.
Expiration via expire_days or expiration_time; server-wide min/max/default expiration and password policies apply.
user_scope restricts access to specific registered users or email recipients (see request body). Restricted links can be managed with the user-auth / email-auth endpoints.

Requires the role permission to generate share links.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Content type of parameter must be application/json and passed through POST request's body.

repo_id

string

required

Library ID

path

string

required

Path of the file or folder to share, / for the whole library

password

string

Optional link password. Must meet the server's password policy (default: at least 10 characters). Mandatory if the server enforces share link passwords.

expire_days

integer

Link expires after this number of days (> 0). Must not be combined with expiration_time. Server-side min/max limits may apply. If neither expire_days nor expiration_time is passed, the server default applies (by default: no expiration).

expiration_time

date-time

Absolute expiration time in ISO 8601 format, e.g. 2026-05-17T10:26:22+02:00. Must not be combined with expire_days.

permissions

object

Link permissions (may also be passed as JSON string). Defaults: can_edit=false, can_download=true, can_upload=false. Resulting modes: preview+download (default), preview only (can_download=false), edit+download, edit only, preview+download+upload (can_upload=true, folders; requires read-write permission on the folder). can_edit is only possible for files that can be edited online.

user_scope

string

enum

Defaults to all_users

Restrict who may open the link: all_users (anyone with the link), specific_users (only the registered users listed in emails), specific_emails (only recipients of the email addresses listed in emails, who verify their address before access).

Allowed:

emails

Only evaluated together with user_scope. For specific_users: JSON array of usernames (account IDs) of registered users; unknown users are ignored. For specific_emails: string with email addresses separated by comma, semicolon or newline; invalid addresses are ignored and each valid address receives a notification email with the link.

Responses

Language

Credentials

Bearer

Account-Token

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Missing repo_id/path, password policy violated, invalid expiration or permissions, link already exists, or link limit reached.

403Encrypted library, insufficient permission on the item for the requested link permissions, or role may not generate share links.

404Library or file/folder not found.