Newer Version Available

This content describes an older version of this product. View Latest

Domain

Read-only object that represents a custom Web address assigned to a site in your organization. This object is available in API version 26.0 and later.

To access this object, Salesforce Sites, Sites, or Site.com must be enabled for your organization.

Supported Calls

describeSObjects(), query(), retrieve()

Special Access Rules

  • Customer Portal users can’t access this object.
  • To view this object, you must have the “View Setup and Configuration” permission.
  • Site.com Publisher users have read-only API access to the Domain and DomainSite objects.

Fields

Field Description
CnameTarget
Type
string
Properties
Filter, Nillable, Sort
Description
The canonical name (CNAME) of the external host or server. If you use a custom domain with a non-Salesforce provider, such as your own external server or CDN provider, to serve your domain, this field points to the CNAME of the external provider. This field is available in API version 43.0 and later.
Domain
Type
string
Properties
Filter, idLookup, Sort
Description
The branded custom Web address within the global namespace identified by this domain's type. In the Domain Name System (DNS) global namespace, this field is the custom Web address that you registered with a third-party domain name registrar. The custom Web address can be used to access the site of this domain.
DomainType
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The global namespace that this custom Web address belongs to. This value is set to DNS for custom Web addresses in the global DNS.
DomainType can have the following value:
  • DNS—Domain Name System (DNS)
HttpsOption
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Current HTTPS option. Values may include:
  • CdnPartner—Content Delivery Network (CDN) partner of Salesforce
  • Community—Community Force.com Subdomain
  • CommunityAlt—Community My Domain
  • ExternalHttps—Domain is served by an external host
  • NoHttps—No HTTPS
  • OrgDomain—My Domain
  • Sites—Salesforce Sites Subdomain
  • SitesAlt—Salesforce Sites My Domain
  • SitesRuntime—Salesforce Cloud
This field is available in API version 47.0 and higher.
OptionsExternalHttps
Type
boolean
Properties
Filter
Description
Indicates whether the domain supports secure connections (true) or not (false) via a non-Salesforce content delivery network (CDN) or endpoint. The value of this field is used only if the domain is not pointing to the yourdomain.your18characterOrgId.live.siteforce.com CNAME target. This field is deprecated in API version 47.0 and later. Use HttpsOption instead.
OptionsHstsHeaders
Type
boolean
Properties
Filter
Description
Indicates whether the HTTP Strict Transport Security (HSTS) response header is included in requests to this domain (true) or not (false). This field is available in API version 47.0 and higher.

Usage

Use this read-only object to query the domains that are associated with each website in your organization.