evilfreelancer/pihole-api-php

Pi-Hole API PHP client

Maintainers

Details

github.com/EvilFreelancer/pihole-api-php

Homepage

Source

Issues

Installs: 3

Dependents: 0

Suggesters: 0

Security: 0

Stars: 4

Watchers: 2

Forks: 2

Open Issues: 0

dev-master 2020-02-29 19:24 UTC

Requires

Requires (Dev)

MIT 7dc9e3ca5aab7745c0536818e26695abf6ab2a53

  • Paul Rock <paul.woop@drteam.rocks>

clientAPI-Clientrest-apipi-hole

This package is auto-updated.

Last update: 2025-03-01 00:29:10 UTC

README

Latest Stable Version Build Status Total Downloads License Code Climate Code Coverage Scrutinizer CQ

Pi-Hole API PHP client

composer require evilfreelancer/pihole-api-php

How to use

$config = new \PiHole\Config([
    'webpassword' => '6b600e5555af97b26ed51a5910a0b310d9da8e22a7aaf97ab0137bb4880ec55e',
    'base_url'    => 'http://192.168.1.10/admin/api.php'
]);

$client = new \PiHole\Client($config);

// Get all stats
$statistics = $client->statistics()->exec();
print_r($statistics);

// Get version of PiHole
$version = $client->version()->exec();
print_r($version);

// Enable ADBlocking on PiHole
$enable = $client->enable()->exec();
print_r($enable);

// Disable ADBlocking on PiHole
$disable = $client->disable()->exec();
print_r($disable);

// Logout from PiHole
$logout = $client->logout()->exec();
print_r($logout);

List of available configuration parameters

Parameter Type Default Description
webpassword string (required) Hash of password
base_url string (required) Url with path to admin.php
proxy string HTTP proxy connection string
json_force_object bool true Will enable flag JSON_FORCE_OBJECT of json_encode
timeout int 10 Max timeout for answer from RouterOS
attempts int 10 Count of attempts to establish TCP session
delay int 1 Delay between attempts in seconds
debug bool true Enable full debug of all HTTP queries

Links