Skip to main content

FileLinkRequest

The settings of an external link to a file.

NameTypeDescriptionNotes
linkIdUUID (uuid)The link to rewrite, as reported by GET api/2.0/files/file/{id}/links. An identifier that is not yet in use, the empty one included, creates a link instead.[optional] [example: 00000000-0000-0000-0000-000000000000]
accessFileShareThe rights the link grants to whoever follows it. The value that denies everything revokes the link.[optional] [enum: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]
expirationDateApiDateTimeThe moment the link stops working, read in the time zone of the portal. A date more than a few years ahead is rejected as an invalid request; left out, the link does not expire on its own.[optional]
titleStringThe name the link carries in the sharing list of the file, for the people who manage it; it is not shown to whoever follows the link.[optional] [example: My Document] [minLength: 0] [maxLength: 255] [nullable]
internalBooleanWho may follow the link: true admits only accounts that are signed in to the portal, false admits anybody who has the address.[optional] [example: false]
primaryBooleanWhether this link becomes the primary link of the file - the one the Copy link action of a client hands out. A file has one primary link at a time.[optional] [example: true]
denyDownloadBooleanWhat a visitor may do with the content: true leaves them with viewing in the browser, false lets them download and print it as their rights allow.[optional] [example: false]
passwordStringThe secret a visitor has to type before the file opens; left out, the link opens without one.[optional] [example: p@ssw0rd] [minLength: 0] [maxLength: 255] [nullable]