linkbreakers-com · Schema

Response containing the setup guide of a custom domain

QR CodesLead CaptureWebhookSDK

Properties

Name Type Description
setupGuide object
View JSON Schema on GitHub

JSON Schema

linkbreakers-com-get-custom-domain-setup-guide-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/linkbreakers-com/json-schema/linkbreakers-com-get-custom-domain-setup-guide-response-schema.json",
  "title": "Response containing the setup guide of a custom domain",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/linkbreakers-com-custom-domains-api-openapi.yml#/components/schemas/GetCustomDomainSetupGuideResponse",
  "properties": {
    "setupGuide": {
      "$ref": "#/$defs/CustomDomainSetupGuide"
    }
  },
  "type": "object",
  "$defs": {
    "CustomDomainDnsRecord": {
      "properties": {
        "detected": {
          "title": "Whether the record is already published with this value, read from public\nDNS when the guide was built",
          "type": "boolean"
        },
        "host": {
          "description": "What to type in the provider's host field: the name relative to the zone,\ne.g. \"qr\". For the zone apex, \"@\", or empty when the provider wants the\nfield left blank.",
          "type": "string"
        },
        "name": {
          "title": "Fully qualified record name, e.g. \"qr.example.com\"",
          "type": "string"
        },
        "purpose": {
          "$ref": "#/$defs/DnsRecordPurpose",
          "title": "Why the record is needed"
        },
        "required": {
          "description": "Whether setup is incomplete without it. The routing record and the\ncertificate delegation record (which keeps HTTPS renewing on its own) are\nboth required.",
          "type": "boolean"
        },
        "type": {
          "$ref": "#/$defs/DnsRecordType",
          "title": "Record type"
        },
        "value": {
          "title": "Record value (CNAME target or TXT content)",
          "type": "string"
        }
      },
      "title": "A DNS record to create at the DNS provider",
      "type": "object"
    },
    "CustomDomainOneClickSetup": {
      "properties": {
        "applyUrl": {
          "description": "URL that opens the DNS provider's consent screen with every record filled in.\nThe provider sends the user back to Linkbreakers when done.",
          "type": "string"
        },
        "providerName": {
          "title": "Name of the DNS provider applying the records",
          "type": "string"
        }
      },
      "title": "One-click setup through Domain Connect",
      "type": "object"
    },
    "CustomDomainSetupGuide": {
      "description": "Everything needed to connect a custom domain, derived from the domain's DNS:\nwho manages it, where to go, and what to add.",
      "properties": {
        "customDomainId": {
          "title": "The custom domain ID (UUID)",
          "type": "string"
        },
        "dnsProvider": {
          "$ref": "#/$defs/DnsProvider",
          "title": "The DNS provider managing the zone"
        },
        "dnsProviderName": {
          "title": "Display name of the DNS provider, empty when unknown",
          "type": "string"
        },
        "dnsSettingsUrl": {
          "description": "Link to the provider's DNS settings for this zone, or to its domain list\nwhen no direct link exists. Empty when the provider is unknown.",
          "type": "string"
        },
        "domain": {
          "title": "The custom domain, e.g. \"qr.example.com\"",
          "type": "string"
        },
        "hints": {
          "items": {
            "$ref": "#/$defs/CustomDomainSetupHint"
          },
          "title": "Provider-specific advice to show alongside the records",
          "type": "array"
        },
        "host": {
          "description": "The domain relative to the zone, e.g. \"qr\". Empty when the domain is the zone itself.",
          "type": "string"
        },
        "hostFieldLabel": {
          "title": "What the provider calls the host field of a DNS record, e.g. \"Name\" or \"Host\"",
          "type": "string"
        },
        "nameservers": {
          "items": {
            "type": "string"
          },
          "title": "The zone's nameservers",
          "type": "array"
        },
        "oneClickSetup": {
          "$ref": "#/$defs/CustomDomainOneClickSetup",
          "title": "Present only when the provider supports one-click setup for Linkbreakers"
        },
        "records": {
          "items": {
            "$ref": "#/$defs/CustomDomainDnsRecord",
            "type": "object"
          },
          "title": "Records to create, in the order to add them",
          "type": "array"
        },
        "zone": {
          "title": "The DNS zone the domain lives in, usually the registered domain, e.g. \"example.com\"",
          "type": "string"
        }
      },
      "title": "Custom domain setup guide",
      "type": "object"
    },
    "CustomDomainSetupHint": {
      "default": "CUSTOM_DOMAIN_SETUP_HINT_UNSPECIFIED",
      "description": "- CUSTOM_DOMAIN_SETUP_HINT_UNSPECIFIED: Not specified\n - CUSTOM_DOMAIN_SETUP_HINT_CLOUDFLARE_DNS_ONLY: Cloudflare: the CNAME's proxy status must be \"DNS only\" (grey cloud), or Linkbreakers cannot see it\n - CUSTOM_DOMAIN_SETUP_HINT_APEX_DOMAIN: The domain is a root domain: most providers do not allow a CNAME there, a subdomain such as qr.example.com is recommended\n - CUSTOM_DOMAIN_SETUP_HINT_NAMESERVERS_NOT_FOUND: The nameservers could not be read: the domain may not be registered yet, or its DNS is not set up\n - CUSTOM_DOMAIN_SETUP_HINT_GOOGLE_DOMAINS_MOVED: The nameservers are Google's. Domains bought through Google Domains use them too and are now managed at Squarespace",
      "enum": [
        "CUSTOM_DOMAIN_SETUP_HINT_UNSPECIFIED",
        "CUSTOM_DOMAIN_SETUP_HINT_CLOUDFLARE_DNS_ONLY",
        "CUSTOM_DOMAIN_SETUP_HINT_APEX_DOMAIN",
        "CUSTOM_DOMAIN_SETUP_HINT_NAMESERVERS_NOT_FOUND",
        "CUSTOM_DOMAIN_SETUP_HINT_GOOGLE_DOMAINS_MOVED"
      ],
      "title": "Provider-specific advice for adding the records",
      "type": "string"
    },
    "DnsProvider": {
      "default": "DNS_PROVIDER_UNSPECIFIED",
      "description": "- DNS_PROVIDER_UNSPECIFIED: Not detected\n - DNS_PROVIDER_UNKNOWN: The nameservers do not match any provider Linkbreakers knows",
      "enum": [
        "DNS_PROVIDER_UNSPECIFIED",
        "DNS_PROVIDER_UNKNOWN",
        "DNS_PROVIDER_CLOUDFLARE",
        "DNS_PROVIDER_GODADDY",
        "DNS_PROVIDER_NAMECHEAP",
        "DNS_PROVIDER_SQUARESPACE",
        "DNS_PROVIDER_IONOS",
        "DNS_PROVIDER_OVHCLOUD",
        "DNS_PROVIDER_GANDI",
        "DNS_PROVIDER_HOSTINGER",
        "DNS_PROVIDER_WIX",
        "DNS_PROVIDER_AWS_ROUTE53",
        "DNS_PROVIDER_GOOGLE_CLOUD_DNS",
        "DNS_PROVIDER_DIGITALOCEAN",
        "DNS_PROVIDER_VERCEL",
        "DNS_PROVIDER_PORKBUN",
        "DNS_PROVIDER_NAME_COM",
        "DNS_PROVIDER_HOVER",
        "DNS_PROVIDER_NETWORK_SOLUTIONS",
        "DNS_PROVIDER_BLUEHOST",
        "DNS_PROVIDER_NETLIFY",
        "DNS_PROVIDER_AZURE_DNS",
        "DNS_PROVIDER_DYNADOT",
        "DNS_PROVIDER_NAMESILO"
      ],
      "title": "DNS provider managing a domain, detected from the zone's nameservers",
      "type": "string"
    },
    "DnsRecordPurpose": {
      "default": "DNS_RECORD_PURPOSE_UNSPECIFIED",
      "description": "- DNS_RECORD_PURPOSE_UNSPECIFIED: Not specified\n - DNS_RECORD_PURPOSE_ROUTING: Sends the domain's traffic to Linkbreakers\n - DNS_RECORD_PURPOSE_CERTIFICATE_DELEGATION: Lets the certificate provider issue and renew the HTTPS certificate on its own\n - DNS_RECORD_PURPOSE_OWNERSHIP: Proves ownership of the domain\n - DNS_RECORD_PURPOSE_CERTIFICATE_VALIDATION: Validates the certificate currently being issued",
      "enum": [
        "DNS_RECORD_PURPOSE_UNSPECIFIED",
        "DNS_RECORD_PURPOSE_ROUTING",
        "DNS_RECORD_PURPOSE_CERTIFICATE_DELEGATION",
        "DNS_RECORD_PURPOSE_OWNERSHIP",
        "DNS_RECORD_PURPOSE_CERTIFICATE_VALIDATION"
      ],
      "title": "Why a DNS record is needed",
      "type": "string"
    },
    "DnsRecordType": {
      "default": "DNS_RECORD_TYPE_UNSPECIFIED",
      "description": "- DNS_RECORD_TYPE_UNSPECIFIED: Not specified\n - DNS_RECORD_TYPE_CNAME: CNAME record\n - DNS_RECORD_TYPE_TXT: TXT record",
      "enum": [
        "DNS_RECORD_TYPE_UNSPECIFIED",
        "DNS_RECORD_TYPE_CNAME",
        "DNS_RECORD_TYPE_TXT"
      ],
      "title": "Type of a DNS record to create",
      "type": "string"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/linkbreakers-com-get-custom-domain-setup-guide-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.