envless.workspace.domain.verify()

def verify(
    *,
    reattempt: bool = False,
    timeout: float | None = None,
) -> CustomDomainResource | None

async def verify(
    *,
    reattempt: bool = False,
    timeout: float | None = None,
) -> CustomDomainResource | None

Runs a single verification pass against the DNS you published. A domain that is not ready yet is not an error: the call returns the new status and failureReason, so branch on status instead of on whether the call raised.

Verification is two staged. The Envless ownership TXT record has to resolve first, and only then is the certificate requested and its own validation records appear in records. A full setup therefore needs at least two calls with a DNS publish between them.

Calls are debounced. Verifying inside the window returns the current state untouched and retryAfterSeconds says when the next real attempt is allowed. Attempts are also capped, and once the cap is spent the only way forward is to remove the domain and claim it again.

Example#

from envless import envless

domain = envless.workspace.domain.verify()

if domain and domain['status'] != 'active':
    print(
        domain['status'],
        domain['failureReason'],
        domain['retryAfterSeconds'],
    )

import asyncio

from envless import AsyncEnvless


async def main() -> None:
    async with AsyncEnvless() as envless:
        domain = await envless.workspace.domain.verify()

        if domain and domain['status'] != 'active':
            print(
                domain['status'],
                domain['failureReason'],
                domain['retryAfterSeconds'],
            )


asyncio.run(main())

Parameters#

Returns#

CustomDomainResource reflecting the pass just run, or None when the API returns no domain.

Worth knowing#

Required scopes#

workspace:write

Underlying endpoint#

In TypeScript#