PowerDNS Authoritative HTTP API, an HTTP API described by an OpenAPI document.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
PowerDNS Authoritative HTTP API, an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|---|---|
GET | /servers | List all servers servers |
GET | /servers/{server_id} | List a server servers |
PUT | /servers/{server_id}/cache/flush | Flush a cache-entry by name servers |
GET | /servers/{server_id}/config | Returns all ConfigSettings for a single server config |
GET | /servers/{server_id}/config/{config_setting_name} | Returns a specific ConfigSetting for a single server NOT IMPLEMENTED config |
GET | /servers/{server_id}/search-data | Search the data inside PowerDNS Search the data inside PowerDNS for search_term and return at most max_results |
GET | /servers/{server_id}/statistics | Query statistics. Query PowerDNS internal statistics. stats |
GET | /servers/{server_id}/tsigkeys | Get all TSIGKeys on the server, except the actual key tsigkey |
POST | /servers/{server_id}/tsigkeys | Add a TSIG key This methods add a new TSIGKey. The actual key can be generated by the server or be provided by |
GET | /servers/{server_id}/tsigkeys/{tsigkey_id} | Get a specific TSIGKeys on the server, including the actual key tsigkey |
PUT | /servers/{server_id}/tsigkeys/{tsigkey_id} | The TSIGKey at tsigkey_id can be changed in multiple ways: * Changing the Name, this will remove the key with |
DELETE | /servers/{server_id}/tsigkeys/{tsigkey_id} | Delete the TSIGKey with tsigkey_id tsigkey |
GET | /servers/{server_id}/zones | List all Zones in a server zones |
POST | /servers/{server_id}/zones | Creates a new domain, returns the Zone on creation. zones |
GET | /servers/{server_id}/zones/{zone_id} | zone managed by a server zones |
PUT | /servers/{server_id}/zones/{zone_id} | Modifies basic zone data. The only fields in the zone structure which can be modified are: kind, masters, acco |
PATCH | /servers/{server_id}/zones/{zone_id} | Creates/modifies/deletes RRsets present in the payload and their comments. Returns 204 No Content on success. |
DELETE | /servers/{server_id}/zones/{zone_id} | Deletes this zone, all attached metadata and rrsets. zones |
PUT | /servers/{server_id}/zones/{zone_id}/axfr-retrieve | Retrieve slave zone from its master. Fails when zone kind is not Slave, or slave is disabled in the configurat |
GET | /servers/{server_id}/zones/{zone_id}/cryptokeys | Get all CryptoKeys for a zone, except the privatekey zonecryptokey |
POST | /servers/{server_id}/zones/{zone_id}/cryptokeys | Creates a Cryptokey This method adds a new key to a zone. The key can either be generated or imported by suppl |
GET | /servers/{server_id}/zones/{zone_id}/cryptokeys/{cryptokey_id} | Returns all data about the CryptoKey, including the privatekey. zonecryptokey |
PUT | /servers/{server_id}/zones/{zone_id}/cryptokeys/{cryptokey_id} | This method (de)activates a key from zone_name specified by cryptokey_id zonecryptokey |
DELETE | /servers/{server_id}/zones/{zone_id}/cryptokeys/{cryptokey_id} | This method deletes a key specified by cryptokey_id. zonecryptokey |
GET | /servers/{server_id}/zones/{zone_id}/export | Returns the zone in AXFR format. zones |
GET | /servers/{server_id}/zones/{zone_id}/metadata | Get all the Metadata associated with the zone. zonemetadata |
POST | /servers/{server_id}/zones/{zone_id}/metadata | Creates a set of metadata entries Creates a set of metadata entries of given kind for the zone. Existing metad |
GET | /servers/{server_id}/zones/{zone_id}/metadata/{metadata_kind} | Get the content of a single kind of domain metadata as a Metadata object. zonemetadata |
PUT | /servers/{server_id}/zones/{zone_id}/metadata/{metadata_kind} | Replace the content of a single kind of domain metadata. Creates a set of metadata entries of given kind for t |
DELETE | /servers/{server_id}/zones/{zone_id}/metadata/{metadata_kind} | Delete all items of a single kind of domain metadata. zonemetadata |
PUT | /servers/{server_id}/zones/{zone_id}/notify | Send a DNS NOTIFY to all slaves. Fails when zone kind is not Master or Slave, or master and slave are disabled |
PUT | /servers/{server_id}/zones/{zone_id}/rectify | Rectify the zone data. This does not take into account the API-RECTIFY metadata. Fails on slave zones and zone |
specification origin: https://raw.githubusercontent.com/PowerDNS/pdns/master/docs/http-api/swagger/authoritative
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.