Network

Get the DNS records required to attach the custom domain

Returns the DNS records that the user must configure on their domain registrar so the edge provider can validate ownership and issue SSL. Cached for 30s per (owner, application).

Requires a custom domain to be attached. Requires the workspace Maintainer or Administrator role (or ownership) when called against a workspace-shared application. Rate limited to 3 calls per 10s per user.

get/v2/apps/{appId}/network/dns

Path parameters

appIdstring required

Application identifier. Optionally suffixed with -<workspaceId> to act on a workspace-shared application.

Response

DNS records the user must add at their registrar. Each entry has a type (txt or cname), a name, a value, and an edge-provider status (e.g. pending, pending_validation, active). Typically returns one or two ownership-validation txt records plus the routing cname pointing at cname.squareweb.app. Empty array when the custom hostname is not registered on the edge yet.

status'success' required

Changes

No recorded changes to this endpoint across all 1 revision of this API.