PortalCustomDomain

object
* Additional properties are NOT allowed.
hostnamestringrequired
enabledbooleanrequired
sslobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
cname_statusstringrequiredread-only

Allowed values:verifiedpending

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

PortalCustomDomainSSL

object
* Additional properties are NOT allowed.
domain_verification_methodstringrequired

Allowed values:httpcustom_certificate

verification_statusstringrequiredread-only

Allowed values:verifiedpendingerror

validation_errorsarray[string]read-only
uploaded_atstring(date-time)read-only

An ISO-8601 timestamp representation of the ssl certificate upload date.

Example:2022-11-04T20:10:06.927Z

expires_atstring(date-time)read-only

An ISO-8601 timestamp representation of the ssl certificate expiration date.

Example:2022-11-04T20:10:06.927Z

skip_ca_checkbooleanread-only

True when the provided certificate chain is served as-is without validation against a public trust store.

Example

UpdatePortalCustomDomainSSL

object
* Additional properties are NOT allowed.
custom_certificatestring

Custom certificate to be used for the SSL termination.

custom_private_keystring

Custom certificate private key to be used for the SSL termination.

skip_ca_checkboolean

Advanced option. If true, the custom certificate is served exactly as provided, without attempting to bundle against a public trust store. Required for certificates issued by an internal/private CA.

Default:false

Example

PortalCustomDomainVerificationMethod

string

Allowed values:httpcustom_certificate

PortalCustomDomainVerificationStatus

string

Allowed values:verifiedpendingerror