Issue with endpoints in current API documentation

[sanguiano1227]

• This is not a support question, I have read about opensource and will send support questions to the IRC channel, GitHub Discussions or the mailing list.
• I have read and understood the 'out in the open' support policy
• I have read and understood the PowerDNS AI policy

• Program: Authoritative
• Issue type: Bug report

Short description

I need to walkthrough all my zones and see if the zone's SOA record has a specific primary nameserver. I have tried two different curls and haven't had much success.

First curl was using the GET /servers/{server_id}/zones which states it would give me all the zones with RRSets. This seems to not be accurate in the documentation because it does not provide that.

Second curl was a result of the first not working. I am having to curl each zone and check the soa rrset. I tried using the query parameters provided: GET /servers/{server_id}/zones/{zone_id}?rrset_name=<zone_name>&rrset_type=SOA . This command does not filter for specifically the SOA, it gives me all that are matching the zone name but that included NS and A records at the apex.

Environment

• Operating system: Enterprise Linux (RHEL and derivatives) 9
• Software version: 5.1 authoritative
• Software source: PowerDNS repository

Steps to reproduce

1. Load zones into Authoritative PowerDNS 51 (or 5.1)
2. Attempt the CURL commands above

Expected behaviour

Curl 1: rrsets to be included
Curl 2: Filter by name and type

Actual behaviour

Curl 1: rrsets not included
Curl 2: filter by name but not by type

Other information

[hlindqvist]

For scenario 1, I believe you are right.

For scenario 2, my experience is that it works as documented (tested with 5.1.3). Could you include the specific non-working example? (There's no confusion like accidentally getting the & mangled by the shell or similar?)

Example curl command that works for me:

curl -v -H 'X-API-Key: changeme' 'http://127.0.0.1:8081/api/v1/servers/localhost/zones/example.com.?rrset_name=example.com.&rrset_type=SOA'

[Habbie]

I think 1 is a doc issue - we provide rrsets (except when rrsets=false on /servers/{server_id}/zones/{zone_id} but not for all zones on /servers/{server_id}/zones, on purpose. Look for // extra stuff getZoneInfo doesn't do for us (more expensive) in ws-auth.cc to see the distinction.

[miodvallat]

Where in the documentation did you get the idea that the /zones endpoint would return all the zones and their rrsets?

As for the filtering problem, I can't reproduce it; can you paste the exact URL you have been using?

[hlindqvist]

Where in the documentation did you get the idea that the /zones endpoint would return all the zones and their rrsets?

I would assume based on how the "Example response" under https://doc.powerdns.com/authoritative/http-api/zone.html#zone-endpoints shows rrsets being a thing in the response.

[miodvallat]

Oh, right, I had missed this in the example. Thanks for pointing at it!

[sanguiano1227]

(There's no confusion like accidentally getting the & mangled by the shell or similar?)

Ah yes, I did not think of this. User error on that one. Thanks for help on that!

So truly, only first scenario is valid. Depends how you all want to fix whether changing the documentation or the code itself, I am mentioning as it is quite misleading, especially for a scenario for mine. Making 30k calls to your API vs one is a time / load difference.