Register a domain

Register a domain for the authenticated workspace. Only available for Enterprise Plans.

POST /domains/register

Python

Python

from dub import Dub


with Dub(
    token="DUB_API_KEY",
) as d_client:

    res = d_client.domains.register(request={
        "domain": "acme.link",
    })

    # Handle response
    print(res)

201

{
  "domain": "<string>",
  "status": "<string>",
  "expiration": 123
}

Domain registration is only available for certain Enterprise customers. Please contact us to get access.

Authorizations

Authorization · string · header · required

Default authentication mechanism

Body

application/json

domain · string · required

The domain to claim. We only support .link domains for now.

Minimum string length: 1

Pattern: .*\.link$

Example:

"acme.link"

Response

201

application/json

The domain was registered.

domain · string · required

The domain name.

status · string · required

The status of the domain registration.

expiration · number | null · required

The expiration timestamp of the domain (Unix timestamp in milliseconds).