Sign in

v29

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-13511526891.2 KB
Brands

Check Host Mapping Validity

Returns a JSON object determining whether a host mapping is valid for a given subdomain.

Allowed for

  • Admins
get/api/v2/brands/check_host_mapping

Query parameters

host_mappingstring required

The hostmapping to a brand, if any (only admins view this key)

subdomainstring required

Subdomain for a given Zendesk account address

Response

Successful response

cnamestring

The canonical name record for a host mapping

expected_cnamesstring[]

Array of expected CNAME records for host mapping(s) of a given brand

is_validboolean

Whether a host mapping is valid or not for a given brand

reasonstring

Reason why a host mapping is valid or not