Pihole
App Vendor: Pihole
App Category: Network Security
Connector Version: 1.0.0
API Version: 1.0.0
About App
Pi-hole is a general purpose network-wide ad-blocker that protects your network from ads and trackers without requiring any setup on individual devices. It is able to block ads on any network device (e.g. smart appliances), and, unlike browser add-ons, Pi-hole blocks ads on any type of software.
The Pi-hole app is configured with the Orchestrate application to perform the following actions:
Action Name | Description |
|---|---|
Add to blacklist | This action adds a domain to the blacklist. |
Add to whitelist | This action adds a domain to a whitelist. |
Get all queries | This action retrieves all the queries. |
Get blacklist | This action retrieves the content of the blacklist. |
Disable a service | This action disables a service. |
Enable a service | This action enables a service. |
Get the summary | This action retrieves the summary. |
Get whitelist | This action retrieves the content of the whitelist. |
Remove from blacklist | This action removes a domain from the blacklist. |
Remove from whitelist | This action removes a domain from the whitelist. |
Configuration Parameters
The following configuration parameters are required for the Pi-hole app to communicate with the Pi-hole enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Base URL | Enter the base URL for your Pi-hole application. Example: "https://<your_pihole_host>.com" | Text | Required | |
Password | Enter the password. | Password | Required | |
SSL verification | Specify your preference to either verify or skip the SSL certificate verification. | Boolean | Optional | Allowed values:
|
Action: Add to blacklist
This action adds a domain to the blacklist.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Domain | Enter the domain. Example: "cyware.com" | Text | Required |
Action: Add to whitelist
This action adds a domain to a whitelist.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Domain | Enter the domain. Example: "cyware.com" | Text | Required |
Action: Get all queries
This action retrieves all the queries.
Action Input Parameters
This action does not require any input parameter.
Action: Get blacklist
This action retrieves the content of the blacklist.
Action Input Parameters
This action does not require any input parameter.
Action: Disable a service
This action disables a service.
Action Input Parameters
This action does not require any input parameter.
Action: Enable a service
This action enables a service.
Action Input Parameters
This action does not require any input parameter.
Action: Get the summary
This action retrieves the summary.
Action Input Parameters
This action does not require any input parameter.
Action: Get whitelist
This action retrieves the content of the whitelist.
Action Input Parameters
This action retrieves the content of the whitelist.
Action: Remove from blacklist
This action removes a domain from the blacklist.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Domain | Enter the domain name. Example: "cyware.com" | Text | Required |
Action: Remove from whitelist
This action removes a domain from the whitelist.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Domain | Enter the domain name. Example: "cyware.com" | Text | Required |