Synq Docs
Management APIBrands

Read a brand's custom domain

Its DNS record, what Synq last saw there, its certificate and whether it answers yet. Needs `org.brands.view`, on any plan.

GET/v1/orgs/{org}/brands/{brand}/custom-domain

Its DNS record, what Synq last saw there, its certificate and whether it answers yet. Needs org.brands.view, on any plan.

Authorization

bearer
AuthorizationBearer <token>

An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.

In: header

Path Parameters

org*string
brand*string

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/orgs/string/brands/string/custom-domain"
{  "id": "string",  "hostname": "string",  "status": "string",  "issuer": "string",  "dns_records": [    {      "type": "string",      "name": "string",      "relative_name": "string",      "value": "string",      "status": "string",      "found": "string"    }  ],  "ssl": {    "status": "string",    "expires_at": "2019-08-24T14:15:22Z"  },  "problems": [    {      "code": "string",      "detail": "string"    }  ],  "verified_at": "2019-08-24T14:15:22Z",  "activated_at": "2019-08-24T14:15:22Z",  "grace_ends_at": "2019-08-24T14:15:22Z",  "checked_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z"}