Domains and DNS

See a domain's settings

GET/api/v1/domains/:domain

Who can use this: Site adminsAs Markdown

Whether the domain takes mail (mail_enabled and active both on), whether its DNS zone is kept here, and who added it when.

Parameters

Name	Where	What it is
domain required	path	The domain name.e.g. example.com

Good to know

A domain that isn't listed answers 404.

curl -s 'https://api.mailmasker.org/api/v1/domains/example.com' \
  -H "Authorization: Bearer $TOKEN"

use Mojo::Base -strict;
use Mojo::UserAgent;

my $ua  = Mojo::UserAgent->new;
my $res = $ua->get('https://api.mailmasker.org/api/v1/domains/example.com',
    { Authorization => "Bearer $ENV{TOKEN}" })->result;
die $res->code, ' ', ($res->json('/error') // $res->message), "\n" unless $res->is_success;
print $res->body, "\n";

homelab-cli dns domains show example.com

Response 200 OK

{
  "id": 1,
  "domain_name": "example.com",
  "mail_enabled": 1,
  "dns_managed": 1,
  "active": 1,
  "created_by": "you@example.com",
  "created_at": "2026-11-03 21:42:10.123456-06",
  "updated_at": "2026-11-03 21:42:10.123456-06"
}