linkbreakers-com · Schema

Response containing the status of a custom domain

QR CodesLead CaptureWebhookSDK

Properties

Name Type Description
customDomain object
View JSON Schema on GitHub

JSON Schema

linkbreakers-com-check-custom-domain-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/linkbreakers-com/json-schema/linkbreakers-com-check-custom-domain-response-schema.json",
  "title": "Response containing the status 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/CheckCustomDomainResponse",
  "properties": {
    "customDomain": {
      "$ref": "#/$defs/CustomDomain"
    }
  },
  "type": "object",
  "$defs": {
    "CustomDomain": {
      "description": "Captures a branded hostname that Linkbreakers provisions for a workspace so scans and shortlinks resolve\nunder the customer's domain, including verification and certificate lifecycle state.",
      "properties": {
        "activatedAt": {
          "description": "Timestamp when the domain became active after passing verification and certificate checks.",
          "format": "date-time",
          "readOnly": true,
          "title": "Timestamp when the domain was successfully set as active",
          "type": "string"
        },
        "certificateExpiresAt": {
          "description": "When the certificate currently serving this domain expires. While the status is STATUS_RENEWAL_PENDING the domain keeps working until this date, then stops.",
          "format": "date-time",
          "readOnly": true,
          "title": "Expiry of the certificate currently serving this domain",
          "type": "string"
        },
        "cloudflareHostnameStatus": {
          "description": "Raw hostname status reported by the certificate provider, recorded at the last check.",
          "readOnly": true,
          "title": "Raw hostname status reported by the certificate provider",
          "type": "string"
        },
        "cloudflareSslStatus": {
          "description": "Raw SSL status reported by the certificate provider, recorded at the last check.",
          "readOnly": true,
          "title": "Raw SSL status reported by the certificate provider",
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "readOnly": true,
          "title": "Timestamp when the domain was created",
          "type": "string"
        },
        "id": {
          "title": "Unique identifier for the custom domain (UUID)",
          "type": "string"
        },
        "lastCheckedAt": {
          "format": "date-time",
          "readOnly": true,
          "title": "Timestamp of the last verification check",
          "type": "string"
        },
        "lastError": {
          "description": "Human-readable reason the domain is not fully active, as reported at the last check. Empty when the domain is healthy.",
          "readOnly": true,
          "title": "Why the domain is not fully active",
          "type": "string"
        },
        "name": {
          "title": "The domain name",
          "type": "string"
        },
        "rootDestination": {
          "description": "URL where visitors are redirected when accessing your custom domain without a path (e.g., qr.yourdomain.com). This redirect is not tracked and serves purely for white-label purposes—preventing visitors from seeing linkbreakers.com branding. If not specified, redirects to linkbreakers.com by default.",
          "title": "Root destination URL",
          "type": "string"
        },
        "status": {
          "description": "The status of a custom domain\n\n - STATUS_UNSPECIFIED: The status is not specified\n - STATUS_INACTIVE: The domain is inactive. It was created but not checked yet.\n - STATUS_DOMAIN_PENDING: The domain is pending. Last time it was checked, it was not pointing to the correct Linkbreakers subdomain.\n - STATUS_VERIFICATION_PENDING: The domain is pending verification. Please verify through TXT record.\n - STATUS_CERTIFICATE_PENDING: The domain is pending certificate. The SSL certificate is not yet ready.\n - STATUS_ACTIVE: The domain is fully active\n - STATUS_RENEWAL_PENDING: The domain is still serving traffic on a valid certificate, but the renewal\nof that certificate cannot be validated. It stops working at certificate_expires_at.\n - STATUS_EXPIRED: The certificate expired or was withdrawn. The domain no longer serves HTTPS.",
          "enum": [
            "STATUS_UNSPECIFIED",
            "STATUS_INACTIVE",
            "STATUS_DOMAIN_PENDING",
            "STATUS_VERIFICATION_PENDING",
            "STATUS_CERTIFICATE_PENDING",
            "STATUS_ACTIVE",
            "STATUS_RENEWAL_PENDING",
            "STATUS_EXPIRED"
          ]
        },
        "updatedAt": {
          "format": "date-time",
          "readOnly": true,
          "title": "Timestamp when the domain was last updated",
          "type": "string"
        },
        "workspaceId": {
          "title": "The ID of the workspace this domain belongs to (UUID)",
          "type": "string"
        }
      },
      "title": "Custom domain",
      "type": "object"
    }
  }
}

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-check-custom-domain-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.