Skip to main content
GET
/
api
/
v1
/
hub
/
shop
/
{shopId}
/
domains
/
instructions
Get Domain Instructions
curl --request GET \
  --url https://api.getscale.ng/api/v1/hub/shop/{shopId}/domains/instructions \
  --header 'X-Shop-API-Key: <x-shop-api-key>'
{
  "status": "success",
  "data": {
    "domain": "myshop.com",
    "misconfigured": true,
    "verificationNote": "Complete DNS verification setup below",
    "config": {
      "a_records": [
        "76.76.21.21"
      ],
      "cname_records": [
        "cname.vercel-dns.com"
      ]
    }
  }
}
Retrieves exact DNS records verification information (A records, CNAME values, and ownership TXT records) required to point your custom domain correctly.

Authorizations

X-Shop-API-Key
string
required
Your Secret API Key (sk_live_... or sk_test_...) generated from the Developer dashboard. Must be kept secret.

Path Parameters

shopId
string
required
The unique UUID of the shop.

Query Parameters

domain
string
required
The custom domain to query details for.
{
  "status": "success",
  "data": {
    "domain": "myshop.com",
    "misconfigured": true,
    "verificationNote": "Complete DNS verification setup below",
    "config": {
      "a_records": [
        "76.76.21.21"
      ],
      "cname_records": [
        "cname.vercel-dns.com"
      ]
    }
  }
}