---
title: "Get the DNS records required to attach the custom domain"
method: GET
path: "/v2/apps/{appId}/network/dns"
tags: ["Network"]
---

# Get the DNS records required to attach the custom domain

`GET /v2/apps/{appId}/network/dns`

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.

## Path parameters

- `appId` string, required

## Response `200`

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.

- object
  - `status` 'success', required
  - `response` DNSRecord[], required
    - `type` 'txt' | 'cname', required — Record type. `txt` covers both ownership and SSL validation; `cname` is the traffic record.
    - `name` string, required — Record name to set at the DNS provider.
    - `value` string, required — Record value. For `cname`, this is always `cname.squareweb.app`.
    - `status` string, required — Upstream validation state (e.g. `pending`, `pending_validation`, `active`). Passed through from the edge provider.

## Other responses

- `400` — The application does not have a custom domain attached.
- `401` — The Authorization header is missing, malformed, or the credentials are not valid.
- `403` — The workspace member does not have the required permission for this endpoint.
- `404` — The target application could not be found, or the caller is not a member of the workspace.
- `429` — The endpoint enforces its own rate limit and the caller hit the cooldown.
- `500` — An unexpected error occurred while processing the request.

---

[API](https://skmtc.dev/squarecloud/apis/square-cloud-api.md) · [All operations](https://skmtc.dev/squarecloud/apis/square-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/squarecloud/square-cloud-api/revisions/54b7733a6b95/schema)
