Files Shares Link

Get, create, and delete a file’s share link.

Resource

1/connect/files/fileId/file-shares/link

1/connect/communities/communityId/files/fileId/file-shares/link

Available since version

36.0

In versions 30.0–35.0, use /chatter/files/fileId/file-shares/link and /connect/communities/communityId/chatter/files/fileId/file-shares/link, which require Chatter.

HTTP methods

GET, PUT, DELETE

Request body for PUT

In version 36.0–57.0, PUT requests don’t require a request body and they ignore any request body provided. In version 58.0 and later, the File Share Link Input request body is available for PUT requests but isn’t required.

Root XML tag

<fileShareLink>

JSON example

1{
2"expirationDate": "2024-07-07T23:59:11.168Z",
3"isPasswordRequired": "true"
4}

Properties

Name	Type	Description	Required or Optional	Available Version
`expirationDate`	String	Expiration date of the generated public link.	Optional	58.0
`isPasswordRequired`	Boolean	Specifies whether a password is needed for the file’s public link (`true`) or not (`false`). Specifying `true` generates a password.	Optional	58.0

Response body for GET or PUT

File Share Link

Response for DELETE

204: Successful Delete

Connect REST API Developer Guide

Files Shares Link