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

# Add a custom domain

> Attach a custom domain to an App.

Returns a `verification_token` and `cname_target`. To prove ownership,
add a DNS TXT record:

    _mixpeek-verify.{domain}  TXT  "mixpeek-site-verification={verification_token}"

Then call `POST /{app_id}/domains/{domain}/verify` to start polling.



## OpenAPI

````yaml post /v1/apps/{app_id}/domains
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security: []
paths:
  /v1/apps/{app_id}/domains:
    post:
      tags:
        - Apps
      summary: Add a custom domain
      description: |-
        Attach a custom domain to an App.

        Returns a `verification_token` and `cname_target`. To prove ownership,
        add a DNS TXT record:

            _mixpeek-verify.{domain}  TXT  "mixpeek-site-verification={verification_token}"

        Then call `POST /{app_id}/domains/{domain}/verify` to start polling.
      operationId: add_domain_v1_apps__app_id__domains_post
      parameters:
        - name: app_id
          in: path
          required: true
          schema:
            type: string
            description: App ID (e.g. app_abc123def456)
            title: App Id
          description: App ID (e.g. app_abc123def456)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddDomainRequest'
      responses:
        '200':
          description: The newly added domain configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    AddDomainRequest:
      properties:
        domain:
          type: string
          title: Domain
          description: Customer domain (e.g. 'search.acme.com')
        is_primary:
          type: boolean
          title: Is Primary
          description: Set as primary domain
          default: false
      type: object
      required:
        - domain
      title: AddDomainRequest
    DomainResponse:
      properties:
        domain:
          type: string
          title: Domain
        status:
          type: string
          title: Status
        verification_token:
          anyOf:
            - type: string
            - type: 'null'
          title: Verification Token
        cname_target:
          anyOf:
            - type: string
            - type: 'null'
          title: Cname Target
        is_primary:
          type: boolean
          title: Is Primary
        verified_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Verified At
      type: object
      required:
        - domain
        - status
        - is_primary
      title: DomainResponse
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````