Newer Version Available

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

DomainProvision

Represents provisioned changes to custom domains. This object is available in API version 50.0 and later.

Custom domains are domains that you own, such at https://www.example.com, that serve your site content. When you save a change to a custom domain, Salesforce provisions the updated domain and a corresponding DomainProvision record is created. The latest DomainProvision record for a Domain represents the current state of the domain.

Supported SOAP API Calls

describeSObjects(), query(), retrieve()

Supported REST API Methods

GET, HEAD, Query

Special Access Rules

Only users with the Salesforce Integration user permission can access this object.

Fields

Field Details
CnameTarget
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Represents the canonical name (CNAME) of the external host or server for this domain. If you use 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.
IsActive
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Represents whether the provisioning for this domain is processing or complete (true) or not (false). When you activate a provisioned domain, this field is set to false.
The default value is false.
ProvisionEndDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Represents when the provisioning process was finished.
ProvisionFinalizeDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Represents when the provisioning process was canceled or when the provisioned domain was activated.
ProvisionStartDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Represents when the provisioning process started.
TargetCdnCertificate
Type
string
Properties
Filter, Group, Nillable, Sort
Description
If the domain is served on the Salesforce Content Delivery Network (CDN), represents the certificate that serves this domain.
If your domain uses another domain configuration option, this field is null.
TargetDomainName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Represents the domain name, such as www.example.com.