Get Storefront Domain DNS Instructions (v1)

Method & Path

GET /api/v1/workspace/:workspaceId/storefront/domain/:domainId/dns-instructions

Description

Retrieve DNS configuration instructions for domain verification.

Authentication

Required: Workspace authentication. User must be authenticated as Workspace Owner or Staff with store.manage permission.

Headers

Authorization: Bearer <workspace_token>
Content-Type: application/json

Path Parameters

Parameter	Type	Required	Description
workspaceId	string	Yes	Workspace identifier
domainId	string	Yes	Domain identifier

Response 200 OK

{
  "instructions": {
    "recordType": "TXT",
    "name": "@",
    "value": "google-site-verification=abc123",
    "ttl": 3600,
    "description": "Add this TXT record to your domain's DNS settings"
  }
}

Response Fields

• instructions (object): DNS configuration instructions
  • recordType (string): DNS record type (TXT)
  • name (string): DNS record name (@ for root domain)
  • value (string): DNS record value (verification token)
  • ttl (number): Time to live in seconds
  • description (string): Human-readable description

Common Errors

401 Unauthorized: Missing or invalid authentication token

403 Forbidden: User does not have store.manage permission

404 Not Found: Workspace or domain not found

500 Internal Server Error: Server error occurred while processing the request