> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scanova.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 添加自定义域名

> POST /custom-domain/

在 **Management API** 主机（`api.scanova.io`）上为账户连接一个新的自定义域名，使用您的原始 Management API 密钥进行身份验证。

```
POST https://api.scanova.io/custom-domain/
Authorization: 401f7ac837da42b97f613d789819ff93537bee6a
```

<ParamField body="domain" type="string" required>
  要连接的域名，例如 `links.example.com`。协议前缀、结尾斜杠和大小写都会自动规范化——您可以按任意形式发送。
</ParamField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST "https://api.scanova.io/custom-domain/" \
    -H "Authorization: 401f7ac837da42b97f613d789819ff93537bee6a" \
    -H "Content-Type: application/json" \
    -d '{ "domain": "links.example.com" }'
  ```
</RequestExample>

<ResponseExample>
  ```json 201 theme={null}
  {
    "id": 42,
    "domain": "https://links.example.com",
    "is_default": false,
    "disable_slug_case": false,
    "txt_value": "scanova-verification=abc123...",
    "is_txt_verified": false,
    "is_cname_verified": false,
    "is_migrated": false,
    "dns_provider": { "name": "Cloudflare", "placeholders": { "cname": { "content": { "label": "Target" } } } },
    "txt_error": null,
    "cname_error": null,
    "root_action": "no_action",
    "redirect": null,
    "template": null,
    "protocol": "https",
    "remove_qr_query": false,
    "cname_target": "shortcname.scanova.io",
    "domain_connect_supported": false,
    "domain_connect_checked_at": null,
    "created": "2026-09-08T10:00:00Z",
    "modified": "2026-09-08T10:00:00Z"
  }
  ```
</ResponseExample>

添加域名并不会对其进行验证——响应中的 `txt_value` 和 `cname_target` 是您（或域名所有者）仍需添加的 DNS 记录，`is_txt_verified`/`is_cname_verified` 初始为 `false`。Scanova 会在创建后异步检查该域名的注册商是否支持 Domain Connect 一键设置；该检查完成后，`domain_connect_supported` 将反映结果。

如果域名无效或已连接到任何账户（唯一性检查不区分大小写），则返回 `400`。如果账户缺少 `CUSTOM_DOMAIN` 配额、套餐不活跃、缺少 `CUSTOM_DOMAIN_CAN_ADD` 权限，或已达到域名数量上限，则返回 `403`。

## 相关内容

* [列出自定义域名](/zh/api-reference/management-api/custom-domain/list)——查看已连接的域名。
* [验证自定义域名的 DNS 记录](/zh/api-reference/management-api/custom-domain/verify)——添加后检查记录。
* [获取 Domain Connect 设置链接](/zh/api-reference/management-api/custom-domain/domain-connect-link)——如受支持，可一键完成 DNS 设置。
* [通过邮件发送 DNS 设置说明](/zh/api-reference/management-api/custom-domain/send-instructions)——将手动步骤转交给他人处理。
* [Management API 概览](/zh/api-reference/management-api/overview)——适用于此端点的身份验证方案和配额规则。


## OpenAPI

````yaml api-reference/openapi/management-api.json POST /custom-domain/
openapi: 3.1.0
info:
  title: Scanova Management API (v2)
  description: >-
    The complete Scanova Management API — every endpoint available at
    api.scanova.io (QR codes, folders, tags, leads, forms, analytics, plans,
    shared users & roles), plus the token-creation and usage-stats endpoints
    used to authenticate against it. Every path and request/response shape below
    was verified live against a real API key and the actual running backend
    (Phase 7, 2026-08-16) — not guessed from reading urls.py alone.
  version: 2.0.0
servers:
  - url: https://api.scanova.io
    description: Management API — QR/folder/tag/lead/form/analytics/plans endpoints
security:
  - apiKeyAuth: []
paths:
  /custom-domain/:
    post:
      summary: Add a custom domain
      description: >-
        Requires the CUSTOM_DOMAIN plan quota and CUSTOM_DOMAIN_CAN_ADD
        permission, plus an active plan. Triggers async Domain Connect support
        discovery.
      operationId: createCustomDomain
      requestBody:
        content:
          application/json:
            example:
              domain: links.example.com
      responses:
        '201':
          description: Domain added.
          content:
            application/json:
              example:
                id: 42
                domain: https://links.example.com
                is_default: false
                disable_slug_case: false
                txt_value: scanova-verification=abc123...
                is_txt_verified: false
                is_cname_verified: false
                is_migrated: false
                dns_provider:
                  name: Cloudflare
                  placeholders:
                    cname:
                      content:
                        label: Target
                txt_error: null
                cname_error: null
                root_action: no_action
                redirect: null
                template: null
                protocol: https
                remove_qr_query: false
                cname_target: shortcname.scanova.io
                domain_connect_supported: false
                domain_connect_checked_at: null
                created: '2026-09-08T10:00:00Z'
                modified: '2026-09-08T10:00:00Z'
        '400':
          description: Invalid or duplicate domain (case-insensitive uniqueness check).
        '403':
          description: >-
            Missing CUSTOM_DOMAIN quota, inactive plan, missing
            CUSTOM_DOMAIN_CAN_ADD permission, or domain limit reached.
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Send your Management API key as the raw value of the Authorization
        header — no "Bearer " or "Token " prefix, and no other characters.
        Example: `Authorization: 401f7ac837da42b97f613d789819ff93537bee6a`. A
        header containing more than one space-separated part is rejected
        outright. Requests also require the request's Host header to be the
        management API host (e.g. api.scanova.io) — the same key sent to the
        regular API host will not authenticate.

````