assets

Create a public link that opens every file in a folder

Mint a folder link: every LIVE file in it becomes readable through the link, and every file filed into it afterward joins automatically. Needs the same authority as publishing each file in it today (its author, or an admin) — refused with no count and no names when the caller cannot publish every file. Behind the asset_folder_sharing_enabled kill switch.

post/v1/assets/folders/{folder_id}/share-links

Request

  • Base URL: https://api.patricia.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.patricia.app/v1/assets/folders/{folder_id}/share-links
  • Auth: HTTP bearer

Path parameters

folder_idstring uuid required

The folder's id.

Headers

X-Tenant-Idstring nullable

Request body

expires_in_daysinteger nullable

How many days the link works for, from now. Defaults to 30, and a chosen number must be between 1 and 365. Send null for a link with no end date, which then works until somebody turns it off, the file is deleted, or the file is set to 'Only me'. Each of those three REVOKES it, so none of them can be undone by re-sharing the file.

refresh_deadlineboolean

Whether handing back a link this caller already has open may move its end date outward. True, the default, is a republish: the deadline moves to whichever of the two dates is later, never inward. Moving it is the file author's or a workspace admin's act unless the file is already 'Anyone with the link'; anyone else gets their link back unchanged, and deadline_moved in the response says which happened. Send false when the request is only for the file's address, so reading a URL cannot keep a capability alive by being asked for. It changes nothing when there is no link to hand back; one is minted either way. This body serves the FOLDER mint too, which has nothing to hand back: a folder link is always a new row, so the field does not apply there and that route ignores it.

Response

Successful Response

idstring uuid required
tokenstring required

The capability. Shown once; the server stores only its hash.

urlstring required

The full share URL, ready to copy. Opens the folder's public page.

created_atstring date-time required
expires_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.