Skip to main content

Domain

A domain for an environment

type Domain {
  active: Boolean
  certificate: Certificate
  certificates(
    after: String
    first: Int
  ): CertificateList
  createdAt: String
  dns: DomainDNSRecord
  emailDeliverabilityLastCheckedAt: String
  environment: AppEnvironment
  hasSSL: Boolean
  id: Int
  isDefault: Boolean
  isDkimValid: Boolean
  isDmarcValid: Boolean
  isLetsEncrypt: Boolean
  isPrimary: Boolean
  isSpfValid: Boolean
  isVerified: Boolean
  letsEncryptCompatibility: [DomainLetsEncryptCompatibility]
  letsEncryptStatus: [DomainLetsEncryptStatus]
  name: String!
  verificationCode: String
  wildcard: String
}

Fields

`Domain.active` ● `Boolean` scalar common

Is the domain currently active?

`Domain.certificate` ● `Certificate` object common

The active certificate of the domain

`Domain.certificates` ● `CertificateList` object common

The matching certificates of the domain

`Domain.certificates.after` ● `String` scalar common

The pagination cursor to continue from.

`Domain.certificates.first` ● `Int` scalar common

The maximum number of certificates to return.

`Domain.createdAt` ● `String` scalar common

The date the domain was added to the system

`Domain.dns` ● `DomainDNSRecord` object common

What is the IP of the domain and does it point to VIP?

`Domain.emailDeliverabilityLastCheckedAt` ● `String` scalar common

When was the email deliverability last checked?

`Domain.environment` ● `AppEnvironment` object common

The environment this domain belongs to

`Domain.hasSSL` ● `Boolean` scalar common

Does this domain have a valid TLS certificate? (Note: SSL is a misnomer there; we are using TLS certificates.)

`Domain.id` ● `Int` scalar common

The unique ID for the domain

`Domain.isDefault` ● `Boolean` scalar common

Is this a default domain? (*.go-vip.co / *.go-vip.net)

`Domain.isDkimValid` ● `Boolean` scalar common

Is the DKIM record valid?

`Domain.isDmarcValid` ● `Boolean` scalar common

Is the DMARC record valid?

`Domain.isLetsEncrypt` ● `Boolean` scalar common

Is the domain using a Let's Encrypt certificate

`Domain.isPrimary` ● `Boolean` scalar common

Is this the primary domain for the environment?

`Domain.isSpfValid` ● `Boolean` scalar common

Is the SPF record valid?

`Domain.isVerified` ● `Boolean` scalar common

Is the domain ownership verified?

`Domain.letsEncryptCompatibility` ● `[DomainLetsEncryptCompatibility]` list object common

What are the issues that may block LE provisioning for this domain?

`Domain.letsEncryptStatus` ● `[DomainLetsEncryptStatus]` list object common

What is the status of LE provisioning?

`Domain.name` ● `String!` non-null scalar common

The domain name (i.e. something like example.com or sub.example.com)

`Domain.verificationCode` ● `String` scalar common

The generated TXT record for the domain

`Domain.wildcard` ● `String` scalar common

The wildcard value for the current domain

Returned By

Member Of

AppEnvironment object ● AppEnvironmentActivateLetsEncryptOnDomainPayload object ● AppEnvironmentAddDomainPayload object ● AppEnvironmentDeactivateDomainPayload object ● AppEnvironmentPrimaryDomainSwitchPayload object ● AppEnvironmentUpdateSubsiteDomainPayload object ● DomainList object ● PrimaryDomainSwitchJob object

Fields
Returned By
Member Of