|
191 | 191 | </li> |
192 | 192 | </ul> |
193 | 193 | </li> |
| 194 | + <li class="toctree-l2"><a class="reference internal" href="#powerdns-metrics-api-v403">PowerDNS Metrics API (v4.0.3+)</a> |
| 195 | + <ul> |
| 196 | + <li class="toctree-l3"><a class="reference internal" href="#configuration">Configuration</a> |
| 197 | + </li> |
| 198 | + <li class="toctree-l3"><a class="reference internal" href="#basic-authentication-for-metrics-v403">Basic Authentication for Metrics (v4.0.3+)</a> |
| 199 | + </li> |
| 200 | + </ul> |
| 201 | + </li> |
| 202 | + <li class="toctree-l2"><a class="reference internal" href="#pagination-v401">Pagination (v4.0.1+)</a> |
| 203 | + <ul> |
| 204 | + <li class="toctree-l3"><a class="reference internal" href="#optional-pagination-parameters">Optional Pagination Parameters</a> |
| 205 | + </li> |
| 206 | + <li class="toctree-l3"><a class="reference internal" href="#pagination-response">Pagination Response</a> |
| 207 | + </li> |
| 208 | + </ul> |
| 209 | + </li> |
| 210 | + <li class="toctree-l2"><a class="reference internal" href="#version-history">Version History</a> |
| 211 | + <ul> |
| 212 | + <li class="toctree-l3"><a class="reference internal" href="#v410">v4.1.0</a> |
| 213 | + </li> |
| 214 | + <li class="toctree-l3"><a class="reference internal" href="#v404">v4.0.4</a> |
| 215 | + </li> |
| 216 | + <li class="toctree-l3"><a class="reference internal" href="#v403">v4.0.3</a> |
| 217 | + </li> |
| 218 | + <li class="toctree-l3"><a class="reference internal" href="#v402">v4.0.2</a> |
| 219 | + </li> |
| 220 | + <li class="toctree-l3"><a class="reference internal" href="#v401">v4.0.1</a> |
| 221 | + </li> |
| 222 | + <li class="toctree-l3"><a class="reference internal" href="#v400">v4.0.0</a> |
| 223 | + </li> |
| 224 | + </ul> |
| 225 | + </li> |
| 226 | + <li class="toctree-l2"><a class="reference internal" href="#related-documentation">Related Documentation</a> |
| 227 | + </li> |
194 | 228 | </ul> |
195 | 229 | </li> |
196 | 230 | <li class="toctree-l1"><a class="reference internal" href="../whois/">WHOIS Configuration</a> |
|
251 | 285 | </li> |
252 | 286 | <li class="toctree-l1"><a class="reference internal" >v4.x Series</a> |
253 | 287 | <ul> |
| 288 | + <li class="toctree-l2"><a class="reference internal" href="../../upgrading/v4.1.0/">v4.1.0</a> |
| 289 | + </li> |
254 | 290 | <li class="toctree-l2"><a class="reference internal" href="../../upgrading/v4.0.0/">v4.0.0</a> |
255 | 291 | </li> |
256 | 292 | </ul> |
@@ -608,6 +644,104 @@ <h3 id="debugging">Debugging</h3> |
608 | 644 | ], |
609 | 645 | </code></pre> |
610 | 646 | <p>Check logs in your configured logging destination for detailed request/response information.</p> |
| 647 | +<h2 id="powerdns-metrics-api-v403">PowerDNS Metrics API <em>(v4.0.3+)</em></h2> |
| 648 | +<p>Poweradmin can integrate with PowerDNS metrics endpoints for monitoring and status information.</p> |
| 649 | +<h3 id="configuration">Configuration</h3> |
| 650 | +<pre><code class="language-php">'pdns' => [ |
| 651 | + 'api_url' => 'http://localhost:8081/api/v1', |
| 652 | + 'api_key' => 'your-powerdns-api-key', |
| 653 | + 'server_id' => 'localhost', |
| 654 | + 'metrics' => [ |
| 655 | + 'enabled' => true, |
| 656 | + 'basic_auth' => [ |
| 657 | + 'username' => 'admin', |
| 658 | + 'password' => 'your-password', |
| 659 | + ], |
| 660 | + ], |
| 661 | +], |
| 662 | +</code></pre> |
| 663 | +<h3 id="basic-authentication-for-metrics-v403">Basic Authentication for Metrics <em>(v4.0.3+)</em></h3> |
| 664 | +<p>Starting with v4.0.3, Poweradmin supports Basic Authentication for accessing PowerDNS metrics endpoints (issue #800). This is useful when your PowerDNS API is protected with Basic Auth in addition to API keys.</p> |
| 665 | +<p><strong>Example configuration:</strong></p> |
| 666 | +<pre><code class="language-php">'pdns' => [ |
| 667 | + 'metrics' => [ |
| 668 | + 'enabled' => true, |
| 669 | + 'basic_auth' => [ |
| 670 | + 'username' => 'metrics_user', |
| 671 | + 'password' => 'secure_password', |
| 672 | + ], |
| 673 | + ], |
| 674 | +], |
| 675 | +</code></pre> |
| 676 | +<h2 id="pagination-v401">Pagination <em>(v4.0.1+)</em></h2> |
| 677 | +<h3 id="optional-pagination-parameters">Optional Pagination Parameters</h3> |
| 678 | +<p>Starting with v4.0.1, pagination is optional for zones and users endpoints (issue #803). You can now request all records without pagination limits.</p> |
| 679 | +<p><strong>Without pagination (returns all results):</strong></p> |
| 680 | +<pre><code class="language-bash">GET /api/v1/zones |
| 681 | +GET /api/v1/users |
| 682 | +</code></pre> |
| 683 | +<p><strong>With pagination:</strong></p> |
| 684 | +<pre><code class="language-bash">GET /api/v1/zones?page=1&limit=50 |
| 685 | +GET /api/v1/users?page=2&limit=25 |
| 686 | +</code></pre> |
| 687 | +<h3 id="pagination-response">Pagination Response</h3> |
| 688 | +<pre><code class="language-json">{ |
| 689 | + "success": true, |
| 690 | + "data": [...], |
| 691 | + "pagination": { |
| 692 | + "total": 150, |
| 693 | + "page": 1, |
| 694 | + "limit": 50, |
| 695 | + "pages": 3 |
| 696 | + } |
| 697 | +} |
| 698 | +</code></pre> |
| 699 | +<h2 id="version-history">Version History</h2> |
| 700 | +<h3 id="v410">v4.1.0</h3> |
| 701 | +<ul> |
| 702 | +<li>Improved API stability and error handling</li> |
| 703 | +</ul> |
| 704 | +<h3 id="v404">v4.0.4</h3> |
| 705 | +<ul> |
| 706 | +<li><strong>Fixed:</strong> Basic Auth TypeError when LDAP authentication is enabled (issue #799)</li> |
| 707 | +<li>Resolves compatibility issues between Basic Auth and LDAP</li> |
| 708 | +<li>Properly handles authentication context</li> |
| 709 | +</ul> |
| 710 | +<h3 id="v403">v4.0.3</h3> |
| 711 | +<ul> |
| 712 | +<li><strong>Added:</strong> Basic Auth support for PowerDNS metrics endpoint (issue #800)</li> |
| 713 | +<li>Enables authentication for metrics API calls</li> |
| 714 | +<li>Supports username/password in addition to API keys</li> |
| 715 | +</ul> |
| 716 | +<h3 id="v402">v4.0.2</h3> |
| 717 | +<ul> |
| 718 | +<li><strong>Fixed:</strong> Routing and method validation issues (issue #767)</li> |
| 719 | +<li><strong>Fixed:</strong> Graceful handling of missing optional fields (issue #818)</li> |
| 720 | +</ul> |
| 721 | +<h3 id="v401">v4.0.1</h3> |
| 722 | +<ul> |
| 723 | +<li><strong>Added:</strong> Optional pagination for zones and users endpoints (issue #803)</li> |
| 724 | +<li>Can now request all records without pagination</li> |
| 725 | +<li>Backward compatible with paginated requests</li> |
| 726 | +<li><strong>Fixed:</strong> SOA serial updates on all record operations (issue #804)</li> |
| 727 | +<li>Ensures zone serial increments properly</li> |
| 728 | +<li>Maintains DNS propagation consistency</li> |
| 729 | +</ul> |
| 730 | +<h3 id="v400">v4.0.0</h3> |
| 731 | +<ul> |
| 732 | +<li>Initial API implementation</li> |
| 733 | +<li>API key management system</li> |
| 734 | +<li>RESTful endpoints for zones, records, users</li> |
| 735 | +<li>Permission template management</li> |
| 736 | +<li>Interactive API documentation</li> |
| 737 | +<li>Request logging and audit trails</li> |
| 738 | +</ul> |
| 739 | +<h2 id="related-documentation">Related Documentation</h2> |
| 740 | +<ul> |
| 741 | +<li><a href="../security-policies/">Security Policies</a> - API authentication and authorization</li> |
| 742 | +<li><a href="powerdns-integration.md">PowerDNS Integration</a> - PowerDNS API configuration</li> |
| 743 | +<li><a href="../logging/">Logging Configuration</a> - API request logging setup</li> |
| 744 | +</ul> |
611 | 745 |
|
612 | 746 |
|
613 | 747 | </div> |
|
0 commit comments