Get page password state

GET

/pages/{slug}/password

Whether the page is password-protected, and whether this caller may enable protection.

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

🟢200

application/json

Password protection state.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404NotFound

🟠429TooManyRequests

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://upload.tf/api/v1/pages/mysite/password' \
--header 'x-api-key: <api-key>'

Response Example

200 - Example 1

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

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