Set page password

PUT

/pages/{slug}/password

Set or change the page's link password (6–72 chars). Enabling protection on
an unprotected page requires the owner's passwordProtection entitlement
(Pro+ by default); admins bypass. Changing an existing password is always allowed.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Password set.

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠403Forbidden

🟠404NotFound

🟠429TooManyRequests

🔴500ServerError

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://upload.tf/api/v1/pages/mysite/password' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "password": "a-strong-passphrase"
}'

Response Example

200 - Example 1

{
    "success": true,
    "data": {
        "protected": true
    }
}

Modified at 2026-06-26 19:58:05

Get page password state

Remove page password