Actions27
- Get User Info
- List Folders
- List Albums
- Get Album
- List Items in Album
- List Recent Items
- List Timeline
- Search Photos
- Get Search Filters
- Create Album
- Update Album
- Delete Album
- Get Item Details
- Update Item
- Delete Item
- Add to Favorite
- Remove from Favorite
- List Sharing
- Create Sharing Link
- Update Sharing
- Delete Sharing
- Get Thumbnail
- Download Item
- Get Settings
- Update Settings
- Get User Quota
- List Photos APIs
Create Sharing Link
AI-generatedSummary
Create a sharing link for a specific Synology Photos album with defined name, optional password, and permission level.
Inputs
- Album ID (required) — The identifier of the album for which the sharing link will be created.
- Share Link Name (required) — A unique name to identify the sharing link being created.
- Share Password / Passphrase — An optional password or passphrase to protect access to the shared album.
- Share Permission — The permission level granted via the sharing link; can be 'View', 'Download', or 'Upload'. Defaults to 'View'.
Output shape
a JSON object with success status and details of the created sharing link
The response includes API-specific data about the created sharing link returned by the Synology Photos API, or throws an error if creation fails.
Examples
Example 1: Create a public sharing link named 'HolidayShare' for album ID '12345' with password protection and view permission.
Set 'Album ID' to '12345', 'Share Link Name' to 'HolidayShare', 'Share Password / Passphrase' to a chosen password, and 'Share Permission' to 'View'.
Example 2: Create a download-enabled sharing link for album '67890' without a password.
Set 'Album ID' to '67890', 'Share Link Name' to a unique name, leave 'Share Password / Passphrase' empty, and set 'Share Permission' to 'Download'.