← All types
Ob Object

PortalDomain

A custom domain alias reserved for a Portal. The generated hostname always remains available alongside it.

Fields

The alias's reservation, as a pdm_ TypeID; pass it as reservationId to verify or refresh the alias.

Portal the alias belongs to.

Normalized custom hostname of the alias.

Status last reported by Control.

Possible values (5)
RESERVED

Reserved for this Portal; the TXT proof has not been verified yet and expires at expiresAt.

VERIFIED

DNS ownership proof verified; TLS issuance has not started.

ISSUING

Ownership verified and the HTTP-01 TLS certificate is being issued.

READY

Certificate issued; the alias can serve and may be selected as the canonical hostname.

FAILED

Verification or issuance failed; see errorCode.

DNS TXT record name to publish as ownership proof; cleared once the alias leaves RESERVED.

DNS TXT record value to publish as ownership proof; cleared once the alias leaves RESERVED.

ISO 8601 time an unverified reservation expires, if any.

Control's failure code when verification or issuance failed.

True when this alias is the Portal's canonical hostname.

Referenced by (3)
Exact type SDL
"""
A custom domain alias reserved for a Portal. The generated hostname always remains available alongside it.
"""
type PortalDomain {
  """
  The alias's reservation, as a `pdm_` TypeID; pass it as `reservationId` to verify or refresh the alias.
  """
  id: PortalDomainID! @iac_computed
  """Portal the alias belongs to."""
  portalId: PortalID! @iac_ref(resource: "portal")
  """Normalized custom hostname of the alias."""
  hostname: String!
  """Status last reported by Control."""
  status: PortalDomainStatus!
  """
  DNS TXT record name to publish as ownership proof; cleared once the alias leaves RESERVED.
  """
  proofName: String
  """
  DNS TXT record value to publish as ownership proof; cleared once the alias leaves RESERVED.
  """
  proofValue: String
  """ISO 8601 time an unverified reservation expires, if any."""
  expiresAt: String
  """Control's failure code when verification or issuance failed."""
  errorCode: String
  """True when this alias is the Portal's canonical hostname."""
  isCanonical: Boolean!
}