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

# Connect a domain

> Adds the domain as `pending`. Point its DNS at the platform, then call Verify a domain. Plan limits apply.

**Required permission:** `biolinks:domains:manage`



## OpenAPI

````yaml /api-reference/biolinks.openapi.json post /domains
openapi: 3.1.0
info:
  title: Link in Bio API
  version: 1.0.0
  description: >-
    Link-in-bio pages and their blocks, short links, QR codes, tracking pixels,
    form submissions, analytics and custom domains.
servers:
  - url: https://{domain}/api/v1/biolinks
    description: Your platform domain
    variables:
      domain:
        default: app.example.com
        description: The domain you sign in to, without https://
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Pages
  - name: Blocks
  - name: Short links
  - name: Catalogue
  - name: Analytics
  - name: Submissions
  - name: QR codes
  - name: Pixels
  - name: Domains
paths:
  /domains:
    post:
      tags:
        - Domains
      summary: Connect a domain
      description: >-
        Adds the domain as `pending`. Point its DNS at the platform, then call
        Verify a domain. Plan limits apply.


        **Required permission:** `biolinks:domains:manage`
      operationId: domains.store
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            minLength: 8
            maxLength: 200
          description: >-
            8–200 letters, digits, `.`, `_`, `:` or `-`. Retry with the same key
            and exact same body to get the original response.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - host
              properties:
                host:
                  type: string
                  maxLength: 190
                  example: links.example.com
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Domain'
components:
  schemas:
    Domain:
      type: object
      properties:
        id:
          type: string
          format: uuid
        host:
          type: string
          example: links.example.com
        status:
          type: string
        verified:
          type: boolean
        ssl_active:
          type: boolean
        disabled:
          type: boolean
        last_checked_at:
          type: string
          nullable: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'A workspace API key: `Authorization: Bearer osk_...`'
    apiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: The same workspace API key in the `x-api-key` header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.