---
title: "POST /api/v1/docs-sites/{spaceId}/custom-domain/check"
method: POST
path: "/api/v1/docs-sites/{spaceId}/custom-domain/check"
---

# POST /api/v1/docs-sites/{spaceId}/custom-domain/check

`POST /api/v1/docs-sites/{spaceId}/custom-domain/check`

## Request

- Base URL: `https://falconer.com` (the document declares no server; this is the origin it was published from)
- URL: `https://falconer.com/api/v1/docs-sites/{spaceId}/custom-domain/check`
- Auth: none declared

## Path parameters

- `spaceId` integer, required: Space id, from GET /spaces.

## Headers

- `x-organization-id` string: Required when using OAuth bearer tokens.

## Response `200`

Whether the domain is verified and ready to enable.

- DocsCustomDomainCheck
  - `status` 'none' | 'pending' | 'ready' | 'active' | 'failed', required
  - `reason` string

## Other responses

- `400`: Bad request
- `403`: Public docs are not enabled or permission is missing
- `404`: Docs site or build not found

---

[API](https://skmtc.dev/falconer/apis/falconer-public-api.md) · [All operations](https://skmtc.dev/falconer/apis/falconer-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/falconer/apis/falconer-public-api/revisions/7b303b7ddf6a?raw)