Create Custom Domain

POST /v1/custom-domains

Authentication

Requires authentication via: OAuth2PasswordBearer.

Parameters

Name	In	Type	Required	Description	Constraints
X-API-Key	header	string | null	No		nullable

Request Body

Required: Yes

application/json

Resolved schema:

{
  "properties": {
    "domain": {
      "type": "string",
      "title": "Domain",
      "description": "Custom domain to map (e.g., example.com)"
    },
    "share_id": {
      "type": "string",
      "title": "Share Id",
      "description": "Share ID to route this domain to"
    },
    "dns_provider": {
      "type": "string",
      "title": "Dns Provider",
      "description": "ACME DNS provider name (e.g., cloudflare) for lego"
    },
    "dns_credentials": {
      "anyOf": [
        {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Dns Credentials",
      "description": "DNS provider credentials as env var mapping (e.g., CLOUDFLARE_API_TOKEN)"
    }
  },
  "type": "object",
  "required": [
    "domain",
    "share_id",
    "dns_provider"
  ],
  "title": "CustomDomainCreateRequest"
}

Field details:

Field	Type	Required	Description	Constraints
domain	string	Yes	Custom domain to map (e.g., example.com)
share_id	string	Yes	Share ID to route this domain to
dns_provider	string	Yes	ACME DNS provider name (e.g., cloudflare) for lego
dns_credentials	object<string, string> | null	No	DNS provider credentials as env var mapping (e.g., CLOUDFLARE_API_TOKEN)	nullable
dns_credentials.*	string	No

Responses

200

Successful Response

application/json

Resolved schema:

{}

422

Validation Error

application/json

Resolved schema:

{
  "properties": {
    "detail": {
      "items": {
        "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"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

Field details:

Field	Type	Required	Description	Constraints
detail	array<object>	No
detail[]	object	No
detail[].loc	array<string | integer>	No
detail[].loc[]	string | integer	No
detail[].msg	string	No
detail[].type	string	No