Domains and DNS

List domains

GET/api/v1/domains

Who can use this: Site adminsAs Markdown

Mail to a domain is accepted only while both mail_enabled and active are on. dns_managed means its DNS zone is kept here.

Good to know

Yes-or-no fields come back as 1 or 0.

curl -s 'https://api.mailmasker.org/api/v1/domains' \
  -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',
    { 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 list

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"
  },
  {
    "id": 2,
    "domain_name": "example.org",
    "mail_enabled": 0,
    "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"
  }
]