Skip to main content
GET
Get public DNS search fields

Authorizations

​
X-API-Key
string
header
required

Infrawatch API key. Supply the complete key directly as the header value.

Query Parameters

​
q
string

Return only fields whose name or description contains this text, case-insensitively. A dataset can expose thousands of fields, so narrowing is usually faster than downloading the whole document.

Maximum string length: 128
​
namespace
string

Return only fields under this leading name segment, such as tls or http. Use view=namespaces to discover the available segments.

Maximum string length: 128
​
view
enum<string>

Set to namespaces to return the field-name segments and how many fields each holds, instead of the fields themselves. Answers what a dataset covers without transferring the full schema.

Available options:
namespaces
​
limit
integer
default:100

Maximum fields to return when filtering. The response sets truncated when more matched than were returned.

Required range: 1 <= x <= 1000

Response

Public DNS query schema.

Public InfraQL fields and aggregation capabilities for one v1 search dataset.

​
aggregate_fields
object[]
required

Public fields accepted by the dataset aggregate operation.

Required array length: 1 - 32 elements
​
dataset
enum<string>
required

Public dataset identifier. Search API v1 contains exactly hosts, services, DNS, WHOIS, and certificates.

Available options:
hosts,
services,
dns,
whois,
certificates
Allowed value: "dns"
​
language
enum<string>
required

Query language accepted by the dataset's search, count, and aggregate operations where available.

Available options:
infraql
​
query_fields
object[]
required

Canonical public fields accepted in InfraQL expressions for this dataset.

Required array length: 1 - 4096 elements