PowerDNS Authoritative HTTP API
PowerDNS Authoritative HTTP API endpoints from PowerDNS
Developer tools#openapi#developer-tools
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
PowerDNS Authoritative HTTP API endpoints from PowerDNS
Endpoints 32
servers
- GETList all servers
/servers - GETList a server
/servers/:server_id - PUTFlush a cache-entry by name
/servers/:server_id/cache/flush?domain=string
config
- GETReturns all ConfigSettings for a single server
/servers/:server_id/config - GETReturns a specific ConfigSetting for a single server
/servers/:server_id/config/:config_setting_nameNOT IMPLEMENTED
search
- GETSearch the data inside PowerDNS
/servers/:server_id/search-data?q=string&max=0&object_type=stringSearch the data inside PowerDNS for search_term and return at most max_results. This includes zones, records and comments. The * character can be used in…
stats
- GETQuery statistics.
/servers/:server_id/statistics?statistic=string&includerings=trueQuery PowerDNS internal statistics.
tsigkey
- GETGet all TSIGKeys on the server, except the actual key
/servers/:server_id/tsigkeys - POSTAdd a TSIG key
/servers/:server_id/tsigkeysThis methods add a new TSIGKey. The actual key can be generated by the server or be provided by the client - GETGet a specific TSIGKeys on the server, including the actual key
/servers/:server_id/tsigkeys/:tsigkey_id - PUTputTSIGKey
/servers/:server_id/tsigkeys/:tsigkey_idThe TSIGKey at tsigkey_id can be changed in multiple ways: * Changing the Name, this will remove the key with tsigkey_id after adding. * Changing the… - DELETEDelete the TSIGKey with tsigkey_id
/servers/:server_id/tsigkeys/:tsigkey_id
zones
- GETList all Zones in a server
/servers/:server_id/zones?zone=string&dnssec=true - POSTCreates a new domain, returns the Zone on creation.
/servers/:server_id/zones?rrsets=true - GETzone managed by a server
/servers/:server_id/zones/:zone_id?rrsets=true - PUTModifies basic zone data.
/servers/:server_id/zones/:zone_idThe only fields in the zone structure which can be modified are: kind, masters, account, soa_edit, soa_edit_api, api_rectify, dnssec, and nsec3param. All… - DELETEDeletes this zone, all attached metadata and rrsets.
/servers/:server_id/zones/:zone_id - PATCHCreates/modifies/deletes RRsets present in the payload and their comments. Returns 204 No Content on success.
/servers/:server_id/zones/:zone_id - PUTRetrieve slave zone from its master.
/servers/:server_id/zones/:zone_id/axfr-retrieveFails when zone kind is not Slave, or slave is disabled in the configuration. Clients MUST NOT send a body. - GETReturns the zone in AXFR format.
/servers/:server_id/zones/:zone_id/export - PUTSend a DNS NOTIFY to all slaves.
/servers/:server_id/zones/:zone_id/notifyFails when zone kind is not Master or Slave, or master and slave are disabled in the configuration. Only works for Slave if renotify is on. Clients MUST NOT… - PUTRectify the zone data.
/servers/:server_id/zones/:zone_id/rectifyThis does not take into account the API-RECTIFY metadata. Fails on slave zones and zones that do not have DNSSEC.
zonecryptokey
- GETGet all CryptoKeys for a zone, except the privatekey
/servers/:server_id/zones/:zone_id/cryptokeys - POSTCreates a Cryptokey
/servers/:server_id/zones/:zone_id/cryptokeysThis method adds a new key to a zone. The key can either be generated or imported by supplying the content parameter. if content, bits and algo are null, a… - GETReturns all data about the CryptoKey, including the privatekey.
/servers/:server_id/zones/:zone_id/cryptokeys/:cryptokey_id - PUTThis method (de)activates a key from zone_name specified by cryptokey_id
/servers/:server_id/zones/:zone_id/cryptokeys/:cryptokey_id - DELETEThis method deletes a key specified by cryptokey_id.
/servers/:server_id/zones/:zone_id/cryptokeys/:cryptokey_id
zonemetadata
- GETGet all the Metadata associated with the zone.
/servers/:server_id/zones/:zone_id/metadata - POSTCreates a set of metadata entries
/servers/:server_id/zones/:zone_id/metadataCreates a set of metadata entries of given kind for the zone. Existing metadata entries for the zone with the same kind are not overwritten. - GETGet the content of a single kind of domain metadata as a Metadata object.
/servers/:server_id/zones/:zone_id/metadata/:metadata_kind - PUTReplace the content of a single kind of domain metadata.
/servers/:server_id/zones/:zone_id/metadata/:metadata_kindCreates a set of metadata entries of given kind for the zone. Existing metadata entries for the zone with the same kind are removed. - DELETEDelete all items of a single kind of domain metadata.
/servers/:server_id/zones/:zone_id/metadata/:metadata_kind
API details
- Authentication
- An API key in the X-API-Key header
- Operations
- 32 operations on 19 pathsGET 15PUT 8POST 4DELETE 4PATCH 1
- Main resources
- zones 10tsigkey 5zonecryptokey 5zonemetadata 5servers 3config 2search 1stats 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
0.0.13 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the PowerDNS Authoritative HTTP API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the PowerDNS Authoritative HTTP API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List all servers” (GET /servers), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the PowerDNS Authoritative HTTP API?
PowerDNS Authoritative HTTP API endpoints from PowerDNS It is listed under Developer tools and has 32 endpoints.
Who publishes the PowerDNS Authoritative HTTP API?
It is listed from PowerDNS's public API description (an OpenAPI document), not published by PowerDNS on Swastik Codes. Anyone who controls powerdns.com can claim the profile by adding a DNS TXT record.
How do I authenticate with the PowerDNS Authoritative HTTP API?
With an API key in the X-API-Key header.
How many endpoints does the PowerDNS Authoritative HTTP API have?
32 operations on 19 paths (15 GET, 8 PUT, 4 POST, 4 DELETE, 1 PATCH). The largest groups are zones, tsigkey, zonecryptokey, zonemetadata.
Is forking the PowerDNS Authoritative HTTP API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.