---
title: "Check Host Mapping Validity"
method: GET
path: "/api/v2/brands/check_host_mapping"
tags: ["Brands"]
---

# Check Host Mapping Validity

`GET /api/v2/brands/check_host_mapping`

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

#### Allowed for

* Admins

## Query parameters

- `host_mapping` string, required
- `subdomain` string, required

## Response `200`

Successful response

- HostMappingObject
  - `cname` string — The canonical name record for a host mapping
  - `expected_cnames` string[] — Array of expected CNAME records for host mapping(s) of a given brand
  - `is_valid` boolean — Whether a host mapping is valid or not for a given brand
  - `reason` string — Reason why a host mapping is valid or not

---

[API](https://skmtc.dev/botbrains-io/apis/support-api.md) · [All operations](https://skmtc.dev/botbrains-io/apis/support-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/botbrains-io/support-api/revisions/d53eac07ba68/schema)