getDomainStatus

utilitysince 0.2.8not for built apps

Client function: poll a custom domain's validation/activation status.

import { getDomainStatus } from 'flowstack-sdk'

Non-React client function. Poll this after connectDomain until status is issued, then call activateDomain. GET /api/v1/apps/{siteId}/domains/{domain}/status.

Signature

getDomainStatus(credentials, siteId, domain, config?): Promise<ApiResponse<DomainStatusResult>>

Parameters

Param	Type	Notes	Description
`credentials`	`FlowstackCredentials`	required	The app owner's credentials (owner-scoped JWT).
`siteId`	`string`	required	The site/app id to operate on.
`domain`	`string`	required	The custom domain, e.g. `app.example.com`.
`config`	`FlowstackClientConfig`	since 0.2.8	Client config (baseUrl, appScope, tenantId as needed).

Returns

Field	Type	Description
—	`Promise<ApiResponse<DomainStatusResult>>`	`DomainStatusResult`: `{ domain, site_id, status, cert_arn?, validation_records, routing_record, connected_at?, last_check? }`. `status` is one of `validating \| issued \| activating \| live \| failed`.

Examples

Poll until issued

const res = await getDomainStatus(credentials, siteId, 'app.example.com', { appScope });
if (res.ok && res.data.status === 'issued') {
  await activateDomain(credentials, siteId, 'app.example.com', { appScope });
}

WarningOwner/management operation — call it with the app owner's credentials from a builder/dashboard/server context, not from inside the generated app's end-user runtime. builtAppSafe is false.

getDomainStatus

Signature

Parameters

Returns

Examples

See also