Disable a domain

DELETE/api/v1/domains/:domain

Who can use this: Site adminsAs Markdown

Turns the domain off (active becomes 0), so mail to it is refused from now on. Nothing is deleted: its DNS zone is still served and its extra addresses stay. Change a domain's settings with active true turns it back on.

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.
homelab-cli's dns domains disable turns mail_enabled off instead, through Change a domain's settings. Mail to the domain is refused either way.

curl -s -X DELETE '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->delete('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";

There's no homelab-cli command for this yet.

Response 200 OK

{ "ok": true }