envless.workspace.domain.claim()

def claim(
    hostname: str,
    *,
    timeout: float | None = None,
) -> CustomDomainResource | None

async def claim(
    hostname: str,
    *,
    timeout: float | None = None,
) -> CustomDomainResource | None

Attaches a hostname to the workspace and returns the DNS records that prove you own it. Nothing is served on the domain until those records are published and a verify pass succeeds.

A workspace holds at most one custom domain. Claiming again replaces a pending claim and resets its challenge, which throws away an in-flight verification. Re-claiming a hostname that is already active is a no-op and returns it unchanged.

The hostname is canonicalised before validation, so casing and a trailing dot are tolerated. A hostname another workspace has already verified is refused permanently, and custom domains require a paid plan.

Example#

from envless import envless

domain = envless.workspace.domain.claim('vault.example.com')

for record in domain['records'] if domain else []:
    print(record['type'], record['name'], record['value'])

import asyncio

from envless import AsyncEnvless


async def main() -> None:
    async with AsyncEnvless() as envless:
        domain = await envless.workspace.domain.claim('vault.example.com')

        for record in domain['records'] if domain else []:
            print(record['type'], record['name'], record['value'])


asyncio.run(main())

Parameters#

Returns#

CustomDomainResource for the claimed hostname carrying the ownership records to publish, or None when the API returns no domain.

Worth knowing#

Required scopes#

workspace:write

Underlying endpoint#

In TypeScript#