Technitium DNS PHP API Client

[Ente]

I've created a fully featured API client for the Technitium DNSServer in PHP as there seems to be none at the time I was looking for one.

It features every API endpoint present in the APIDOCS.md as of 6th Nov 24. I've also made it easy to use so it can be integrated pretty easily for every use case thinkable.

Installation

Composer:

composer require ente/technitium-dnsserver-php-api

Usage

General

require_once "/vendor/autoload.php";
use Technitium\DNSServer\API;

$api = new API();

// Get all zones
$zones = $api->zones()->get();
// Get all zone records
$records = $api->zones->records()->get("example.com");

// Install an app

$sampleApp = $api->apps()->listStoreApps()["storeApps"][0];
if($api->apps->install($sampleApp["name"])) {
    echo "App installed successfully!";
}

// OR

$sampleApp = $api->apps()->listStoreApps()["storeApps"][0];
if($api->apps->downloadAndInstall($sampleApp["name"], $sampleApp["url"])) {
    echo "App installed successfully!";
}

custom endpoint

<?php

require_once "/vendor/autoload.php";
use Technitium\DNSServer\API;

$api = new API();
// You have to set <bool>$bypass to true to use this feature
echo var_dump($api->sendCall(data: array("field" => "value"), endpoint: "admin/users/list", skip: false, bypass: true))

Dynamic DNS

This requires a additional configuration file, e.g. config.json

{
    "domanin": "example.com",
    "records": [
        "sub.example.com"
    ]
}

Then using the DDNS Helper class to configure records to point to the current IP:

<?php

require_once "/vendor/autoload.php";
use Technitium\DNSServer\API;
use Technitium\DNSServer\API\Helper\DDNS;

$path_to_configJSON = "/my/config.json";
$ddns = new DDNS(new API());
$ddns->updateRecords($path_to_configJSON);

// OR

$ddns_result = new DDNS(new API(), file_get_contents($path_to_configJSON)); // starts automatically updating the records

// OR
$api = new API();
$ddns_result = $api->ddns()->updateRecords($path_to_configJSON);

You can set up multiple configuration files for different domains:

<?php

require_once "/vendor/autoload.php";
use Technitium\DNSServer\API;
use Technitium\DNSServer\API\Helper\DDNS;

DDNS(new API(), file_get_contents("/my/config.json"));
DDNS(new API(__DIR__), file_get_contents("/my/config2.json"));
DDNS(new API(__DIR__ . "/configurations", ".env-custom"), file_get_contents("/my/config3.json"));

[ShreyasZare]

Thanks for posting it here. I am sure many people will find it useful for their projects. I would suggest that you post it on reddit.com/r/technitium too so that it reaches to more people.

[Ente]

That's a great idea! I wasn't aware of the subreddit