Skip to content

List domains and names

List the custom domain names you can manage and their DNS states. Name a Computer to see the domains and paths that reach it.

Parameters

#
computerstring
Computer name or ID.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobjectAlways present
The organization's DNS destination, connected domains and names assigned to Computers.
Show 4 attributesHide attributes
domainsobject[] | nullAlways present
Domains connected to the organization and who can use them.
Show 1 attributeHide attributes
itemsobject
A domain connected to an organization.
Show 6 attributesHide attributes
created_atstring (date-time)Always present
When the domain was connected.
namestringAlways present
Connected domain name.
namesintegerAlways present
Number of its names assigned to Computers.
teamstringAlways present
Selected team when use is restricted to a team.
whostringAlways present
Who in the organization can assign names under this domain.
wholebooleanAlways present
Whether DNS sends all names under the domain to the organization.
former_targetsstring[]
Earlier destinations that continue to work. May be omitted.
namesobject[] | nullAlways present
Names assigned to Computers in the selected scope.
Show 1 attributeHide attributes
alternative-1object[]
The domain names assigned to Computers in the selected scope.
Show 1 attributeHide attributes
itemsobject
A Computer's domain name and its DNS and certificate status.
Show 18 attributesHide attributes
added_atstring (date-time)Always present
When the name was assigned.
certificate_statestring
HTTPS certificate's current state, when applicable. May be omitted.
computerstringAlways present
Destination Computer's name.
computer_idstringAlways present
Destination Computer's ID.
dns_checked_atstring (date-time) | nullAlways present
When DNS was last checked.
dns_failing_sincestring (date-time) | nullAlways present
When the current DNS failure began.
dns_messagestring | nullAlways present
An explanation of the DNS problem, when present.
dns_reasonstring | nullAlways present
DNS problem code, or null without a recorded problem.
dns_statestringAlways present
Latest DNS-check state.
domainstringAlways present
Registrable domain containing this name.
maintenance_pausedbooleanAlways present
Whether automatic domain maintenance is paused.
namestringAlways present
Full domain name.
pathsobject[] | nullAlways present
Path-specific routes to other Computers.
Show 1 attributeHide attributes
itemsobject
A path under a domain name routed to a Computer.
Show 5 attributesHide attributes
computerstringAlways present
Destination Computer's name.
computer_idstringAlways present
Destination Computer's ID.
pathstringAlways present
URL path prefix to match.
portinteger
Destination port when explicitly selected. May be omitted.
strip_prefixboolean
Whether forwarding removes the matched prefix. May be omitted.
portinteger | nullAlways present
Guest port; null uses the Computer's website setting.
proxiedbooleanAlways present
Whether Cloudflare's proxy sits in front of the name.
redirectstringAlways present
Redirect destination, when this name redirects.
unprovenbooleanAlways present
Whether the name is still waiting for DNS proof.
wildcardbooleanAlways present
Whether this is a wildcard name.
targetstringAlways present
Target for new DNS records.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • API key permission: domain view.