Syndai Docs

Read an app's custom domain

GET
/api/v1/external/coding/customers/{customer_id}/apps/{publication_id}/domain

The hosted site's own address. status: none, pending (Cloudflare has not seen the records yet, or the certificate is issuing), active (the site serves there and its Syndai address redirects to it), failed (validation timed out: add it again). records: what to add at the domain's DNS host while it is not active: one CNAME for the address (a pending address fails after 72 h if it never appears). The bare domain is the owner's DNS host forwarding to www. domain_connect_url: one tap at the domain's DNS provider (it writes the CNAME, and for a www address the bare-domain forward) once that provider has onboarded Syndai's template. dns_provider / dns_url: the DNS provider's name and DNS page, when known. Poll this while pending: each read re-checks a pending address (at most every 10 s). Needs coding:apps:read.

Authorization

CustomerApiKey
headerAuthorizationBearer <API Key>

Customer API key sent as a bearer token

Path Parameters

customer_id*string
Formatuuid
publication_id*string
Formatuuid

Response Body

Request fulfilled, document follows

application/json
  1. response
delete_records?array<>
dns_provider?string|null
dns_url?string|null
domain_connect_url?string|null
hostname?string|null
records*array<>
status*string
Example Request
curl -X GET 'https://api.syndai.ai/api/v1/external/coding/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08/domain'
Example Response
{  "delete_records": [    {      "name": "string",      "type": "string",      "value": "string"    }  ],  "dns_provider": "string",  "dns_url": "string",  "domain_connect_url": "string",  "hostname": "string",  "records": [    {      "name": "string",      "type": "string",      "value": "string"    }  ],  "status": "string"}