lumail.domains.get

SDK 2.1.0 · API v2 · GET /api/v2/domains/:domain

MethodGET

/api/v2/domains/:domain

Request Examples

import { Lumail } from "lumail";

const lumail = new Lumail({ apiKey: process.env.LUMAIL_API_KEY });
const { data, error } = await lumail.domains.get("mail.example.com");
if (error) {
  throw error;
}
console.log(data.status);

Response Examples

{
  "id": "dom_abc123",
  "domain": "mail.example.com",
  "status": "VERIFIED"
}

[email protected] · lumail.domains

domains.get(domainOrId: string): Promise<LumailResult<DomainRecord>>

Id or hostname.

Path Parameters

Name	Type	Description
`domainOrId`	string	Required. MailDomain id or hostname.

Response Fields

Field	Type	Description
`id`	string	Domain id.
`domain`	string	Hostname.
`status`	string	Verification status (`PENDING`, `VERIFIED`, …).
`region`	string	Optional SES region.
`createdAt`	string	Optional ISO 8601 timestamp.
`sesRecords`	unknown	Optional provider DNS payload.
`dnsRecords`	unknown[]	Optional DNS records to publish.
`message`	string	Optional status note.

data is the domain record. Failures return { data: null, error: { name, message, statusCode } }.

Previouslumail.domains.create Nextlumail.domains.verify