Searching

The API allows searching for data in Zones, Comments and RRSets.

Note

Not all backends support searching in records or comments.

Endpoints

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. This includes zones, records and comments. The * character can be used in search_term as a wildcard character and the ? character can be used as a wildcard for a single character.

Parameters:

• server_id (string) – The id of the server to retrieve

Query Parameters:  

• q (string) – The string to search for
• max (integer) – Maximum number of entries to return
• object_type (string) – Type of data to search for, one of “all”, “zone”, “record”, “comment”

Status Codes:

• 200 OK – Returns a JSON array with results Returns: array of SearchResult objects
• 400 Bad Request – The supplied request was not valid Returns: Error object
• 404 Not Found – Requested item was not found Returns: Error object
• 422 Unprocessable Entity – The input to the operation was not valid Returns: Error object
• 500 Internal Server Error – Internal server error Returns: Error object

Objects

SearchResult

Object Properties:  

• content (string) –
• disabled (boolean) –
• name (string) –
• object_type (string) – set to one of “record, zone, comment”
• zone_id (string) –
• zone (string) –
• type (string) –
• ttl (integer) –