FunnelFlux Pro API DocumentsFunnelFlux Pro API Documents
  • Changelog
  • Status
  • Dashboard
  • Documentation
  • Authentication
  • Domains
  • Assets
  • Reporting
Information
Domains
    List all domainsgetCreate a new domainpostCheck domain configurationpostGet domain detailsgetDelete a domaindeleteRefresh domain statuspost
Schemas
FunnelFlux Custom Domains API
FunnelFlux Custom Domains API

Schemas

Download schema

Error

error
​string

Error code

error_description
​string

Human-readable error description

CreateDomainRequest

domain
​string · required

Domain hostname to add (e.g., track.example.com)

CreateDomainResponse

success
​boolean
​DomainInfo
error_code
​string

Error code if creation failed (e.g., DOMAIN_EXISTS, DOMAIN_ALREADY_OWNED)

error_message
​string

Human-readable error description

message
​string

Success message

GetDomainResponse

success
​boolean
​DomainInfo
error_code
​string

Error code if lookup failed (e.g., NOT_FOUND)

error_message
​string

Human-readable error description

DeleteDomainResponse

success
​boolean
message
​string
error_code
​string

Error code if deletion failed

error_message
​string

Human-readable error description

ListDomainsResponse

success
​boolean
​DomainSummary[]
error_code
​string

Error code if listing failed

error_message
​string

Human-readable error description

CheckDomainRequest

domain
​string · required

Domain hostname to check (e.g., track.example.com)

CheckDomainResponse

success
​boolean · required
found
​boolean · required

Domain routes to FunnelFlux (redirect check passed)

ssl_valid
​boolean · required

SSL certificate is valid (TLS handshake succeeded)

http_status
​integer

HTTP status from debug endpoint

ssl_error
​string

SSL error message if TLS failed

response_time_ms
​integer · int64

Response time in milliseconds

error_message
​string

Error message if check failed

check_timestamp
​integer · int64

Unix timestamp when check was performed

cloudflare_status
​string

Cloudflare hostname status (pending, active, moved, deleted)

cloudflare_ssl_status
​string

Cloudflare SSL status (initializing, pending_validation, active)

RefreshDomainResponse

success
​boolean
​DomainInfo
​CheckDomainResponse

DomainInfo

id
​string · required

Ledger domain ID

domain
​string · required

Domain hostname

owner
​string · required

Owner ID

status
​string · enum · required

Overall status (pending, active, failed)

Enum values:
pending
active
failed
moved
deleted
created_at
​string

ISO timestamp

cloudflare_id
​string

Cloudflare custom hostname ID

​DomainSSLInfo
​DomainOwnershipVerification
verification_errors
​string[]
​DomainParsedInfo

DomainSummary

Summary of a domain from Ledger. Status fields may be empty until RefreshDomain is called to fetch Cloudflare status.
id
​string · required

Ledger domain ID

domain
​string · required

Domain hostname

status
​string · required

Overall status (may be empty until refreshed)

cloudflare_id
​string

Cloudflare custom hostname ID (may be empty)

ssl_status
​string

SSL certificate status (may be empty until refreshed)

verification_errors
​string[]
created_at
​string

ISO timestamp

DomainSSLInfo

status
​string

SSL status (pending_validation, active, etc.)

txt_name
​string

TXT record name for DCV validation

txt_value
​string

TXT record value for DCV validation

DomainOwnershipVerification

type
​string

Verification type (txt)

name
​string

TXT record name for ownership

value
​string

TXT record value for ownership

DomainParsedInfo

subdomain
​string

Subdomain portion (e.g., track) or empty for root

root_domain
​string

Root domain (e.g., example.com)

On this page
  • Error
  • CreateDomainRequest
  • CreateDomainResponse
  • GetDomainResponse
  • DeleteDomainResponse
  • ListDomainsResponse
  • CheckDomainRequest
  • CheckDomainResponse
  • RefreshDomainResponse
  • DomainInfo
  • DomainSummary
  • DomainSSLInfo
  • DomainOwnershipVerification
  • DomainParsedInfo