Get a token for a password-protected external link

POST /api/2.0/files/{fileId}/sharedlink/{linkId}/password

Request

Returns a token after verifying the password or password hash for a password-protected external link.

Note: The token is used in the cookies with the 'sharelink[linkId]' name when calling API methods.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Path

fileIdstring

File ID

linkIdstringformat: uuid

Link ID

Body

passwordstring

Password

passwordHashstring

Password hash

Examples

POST /api/2.0/files/%7BfileId%7D/sharedlink/%7BlinkId%7D/password HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request POST \
  --url https://example.com/api/2.0/files/%7BfileId%7D/sharedlink/%7BlinkId%7D/password \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Token for a password-protected external link

Tokenstring

Expiresstring

Smsboolean

PhoneNoisestring

Tfaboolean

TfaKeystring

401

Unauthorized