Interface Domain

interface Domain {
    autoconfig: boolean;
    createdAt?: Date;
    dkimConfig: string;
    id: string;
    lastError?: string;
    lastValidAt?: Date;
    name: string;
    nextCheckAt?: Date;
    organizationId: string;
    projectId: string;
    records?: DomainRecords;
    region: Region;
    reputation?: DomainReputation;
    revokedAt?: Date;
    spfConfig: string;
    statistics?: DomainStatistics;
    status: TransactionalEmail.v1alpha1.DomainStatus;
}

Properties

autoconfig createdAt? dkimConfig id lastError? lastValidAt? name nextCheckAt? organizationId projectId records? region reputation? revokedAt? spfConfig statistics? status

Properties

autoconfig

autoconfig: boolean

Status of auto-configuration for the domain's DNS zone.

OptionalcreatedAt

createdAt?: Date

Date and time of domain creation.

dkimConfig

dkimConfig: string

DKIM public key to record in the DNS zone.

id

id: string

ID of the domain.

OptionallastError

lastError?: string

Deprecated

Error message returned if the last check failed.

OptionallastValidAt

lastValidAt?: Date

Date and time the domain was last valid.

name

name: string

Domain name (example.com).

OptionalnextCheckAt

nextCheckAt?: Date

Date and time of the next scheduled check.

organizationId

organizationId: string

ID of the domain's Organization.

projectId

projectId: string

ID of the domain's Project.

Optionalrecords

records?: DomainRecords

List of records to configure to validate a domain.

region

region: Region

Region to target. If none is passed will use default region from the config.

Optionalreputation

reputation?: DomainReputation

The domain's reputation is available when your domain is checked and has sent enough emails.

OptionalrevokedAt

revokedAt?: Date

Date and time of the domain's deletion.

spfConfig

spfConfig: string

Snippet of the SPF record to register in the DNS zone.

Optionalstatistics

statistics?: DomainStatistics

Domain's statistics.

status

status: TransactionalEmail.v1alpha1.DomainStatus

Status of the domain.

Settings

On This Page

Properties