SQsquarecloud
Network

Get the DNS records required to attach the custom domain

Changed on

Returns the DNS records that the user must configure on their domain registrar so the edge provider can validate ownership and issue SSL. Cached per (owner, application): 150s while a record is pending, 10 minutes once every record is active.

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

Request

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). Returns the routing cname pointing at cname.squareweb.app first, then the ownership txt while ownership is unverified, then one txt per SSL validation token (_acme-challenge; some certificate authorities issue two tokens under the same name, and both are required). The cname and ownership txt carry the hostname status, each SSL txt the certificate status; the domain is fully set up when every record without fallback is active. A record that is not active may carry errors: the edge provider's own reasons it is not validated yet. Last, flagged fallback: true, comes the DCV delegation: one _acme-challenge cname the owner may create INSTEAD of the SSL txt records (never both), which keeps working across certificate renewals. When the edge cannot be read, the last records read for the same domain (up to 6 hours old); an empty array when there are none or the custom hostname is not registered there yet.

status'success' required

Changes

  • e363e004303cRevision changes
    • warning

      added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status

    • warning

      added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status

    • warning

      added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status

    • warning

      added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status

    • warning

      added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status

    • warning

      added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status

    • warning

      added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status

  • 4cf53a0d5577Revision changes
    • warning

      added the new WRITE_FAILED enum value to the //// response property for the response status

    • warning

      added the new WRITE_FAILED enum value to the //// response property for the response status

    • warning

      added the new WRITE_FAILED enum value to the //// response property for the response status

    • warning

      added the new WRITE_FAILED enum value to the //// response property for the response status

    • warning

      added the new WRITE_FAILED enum value to the //// response property for the response status

    • warning

      added the new WRITE_FAILED enum value to the //// response property for the response status

    • warning

      added the new WRITE_FAILED enum value to the //// response property for the response status

    • warning

      added the new WRONG_HOST enum value to the //// response property for the response status

    • warning

      added the new WRONG_HOST enum value to the //// response property for the response status

    • warning

      added the new WRONG_HOST enum value to the //// response property for the response status

    • warning

      added the new WRONG_HOST enum value to the //// response property for the response status

    • warning

      added the new WRONG_HOST enum value to the //// response property for the response status

    • warning

      added the new WRONG_HOST enum value to the //// response property for the response status

    • warning

      added the new WRONG_HOST enum value to the //// response property for the response status