pagehive

list_site_domains

List a site's custom domains: hostname, role (primary serves the site, redirect sends to it), status (pending, active, dns_lost, disabled, off with off_by owner or plan), the last check's error and the DNS records to create.

Custom domainsRead-onlyBasic and up

What it does

List a site's custom domains: hostname, role (primary serves the site, redirect sends to it), status (pending, active, dns_lost, disabled, off with off_by owner or plan), the last check's error and the DNS records to create. Needs can_custom_domains.

Plans

Needs a paid plan: Basic, Pro or Ultra. On other plans your agent gets an error that says so. See Limits for what each plan includes.

Parameters

NameTypeAbout
site_idrequiredstringThe id of the site. list_sites gives the ids of your sites.

Example

Call list_site_domains with these arguments:

{
  "site_id": "01a1…"
}

Ids like 01a1… stand for your own. list_sites and list_tables give you the real ones.

Related guides