Connect a custom domain

POST

/domains

Connect a globally-unique domain to one of your pages (status pending until
registration completes). Up to a per-user cap. 404 if the feature is disabled.
Domain purchase/registration is session-only and not exposed here.

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 ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Domain connected.

Bodyapplication/json

🟠403

🟠404

🟠400BadRequest

🟠401Unauthorized

🟠409Conflict

🟠429TooManyRequests

🔴500ServerError

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://upload.tf/api/v1/domains' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "domain": "example.com",
    "pageId": "string"
}'

Response Example

201 - Example 1

{
    "success": true,
    "data": {
        "id": "string",
        "domain": "string",
        "pageId": "string",
        "status": "string",
        "statusLabel": "string",
        "createdAt": "2019-08-24T14:15:22.123Z",
        "expiresAt": "2019-08-24T14:15:22.123Z"
    }
}

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

List custom domains

Search domain availability