...
For several platforms, there is an option to share files and folders via a link. The preserved shared links policy determines whether "domain" or "anyone" links are transferred from the source to the destination. Permission Preservation must be configured in your job for Shared Links to be transferred.
...
| Info |
|---|
This option is automatically enabled when shared links only is selected as the item permissions policy. |
| Note |
|---|
Notification emails may be generated on the destination platform when shared links are transferred. |
Supported Platforms
The following platforms support shared links. Refer to the Platform Comparison to see conflict between platforms.
...
: Feature is not supported by the Platform.
| Box | Dropbox | SharePoint Online | Google Workspace |
|---|
Number of Links | 1 link per file or folder | 1 link per file or folder | multiple links per file or folder | Max 2 links; anonymous and/or a domain |
Rights | | Status |
|---|
| colour | Purple |
|---|
| title | READ/VIEW RIGHTS UNSAFE-ONLY |
|---|
|
| | Status |
|---|
| colour | Purple |
|---|
| title | READ/VIEW RIGHTS UNSAFE-ONLY |
|---|
|
VIEW -ONLY | | Status |
|---|
| colour | Purple |
|---|
| title | READ/VIEW AND WRITE/EDIT |
|---|
|
DEDIT | | Status |
|---|
| colour | Purple |
|---|
| title | READ/VIEW AND WRITE/EDIT |
|---|
|
RITE/ |
Expiration Date | | Status |
|---|
| colour | Green |
|---|
| title | supported |
|---|
|
| | Status |
|---|
| colour | Green |
|---|
| title | supported |
|---|
|
PPORTED | | Status |
|---|
| colour | Blue |
|---|
| title | ANYONE LINKS UNSAFE-ONLY |
|---|
|
| | Status |
|---|
| colour | Purple |
|---|
| title | READ/VIEW RIGHTS UNSAFE-ONLY |
|---|
|
FE-ONLY |
Link Passwords | | Status |
|---|
| colour | Red |
|---|
| title | not supported |
|---|
|
| | Status |
|---|
| colour | Red |
|---|
| title | not supported |
|---|
|
ORTED | | |
Disable Download | | Status |
|---|
| colour | Red |
|---|
| title | not supported |
|---|
|
| | Status |
|---|
| colour | Red |
|---|
| title | not supported |
|---|
|
T | | |
...
REST API Examples
These are the two REST API requests you can use to get the information on each type of shared link.
...
Example | Shared Links Basic Job
POST {{url}}v1/jobs |
|---|
| Code Block |
|---|
{
"name":"Shared Links Example",
"kind": "transfer",
"transfer": {
"transfer_type": "copy",
"large_item": "skip",
"batch_mode": "always",
"timestamps": "true",
"tags": "none",
"permissions": {
"policy": "add",
"links": true,
"failures": "exceptions"
},
"segment_transform": true,
"preserve_owners": true,
"duplicate_names": "rename",
"empty_containers": "create",
"versioning": {
"preserve": "native",
"select": "all"
},
"source": {
"connection": { "id": "{{cloud_connection_source}}" },
"target": {
"path": "/sourcePath"
}
},
"destination": {
"connection": { "id": "{{cloud_connection_destination}}" },
"target": {
"path": "/destinationPath"
}
}
},
"schedule": {
"mode": "manual"
},
"stop_policy": {
"on_success": 2,
"on_failure": 2
},
"category": {
"name": "Report | Shared Link Jobs"
}
} |
|
Example | Shared Links with Permissions Import
POST {{url}}v1/jobs |
|---|
| Code Block |
|---|
{
"name":"Shared Links with Permissions Import",
"kind": "transfer",
"transfer": {
"audit_level": "trace",
"transfer_type": "copy",
"permissions": {
"policy": "add",
"failures": "exceptions",
"links": true,
"import": {
"source": {
"text": {
["delimiter"]: ",", //optional, defaults to comma
"target": {
"path": "/permissions_import.csv"
}
}
},
"output": {
"format": "text"
}
}
},
"source": {
"connection": {
"id": "{{nfs_connection}}"
},
"target": {
"path":"/"
}
},
"destination": {
"connection": {
"id": "{{cloud_connection}}"
},
"target": {
"path": "/destinationPath"
}
}
},
"schedule": {
"mode": "manual"
},
"stop_policy": {
"on_success": 2,
"on_failure": 2
},
"category": {
"name": "Report | Shared Link Jobs"
}
} |
|