Schema
curl --request GET \
--url https://api.infrawatch.com/api/v1/search/schema \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.infrawatch.com/api/v1/search/schema"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.infrawatch.com/api/v1/search/schema', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.infrawatch.com/api/v1/search/schema"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"schemas": [
{
"aggregate_fields": [
{
"count_unit": "host",
"name": "country_code",
"type": "string"
},
{
"count_unit": "host",
"name": "tags",
"type": "string"
},
{
"count_unit": "service",
"name": "services.tags",
"type": "string"
},
{
"count_unit": "host",
"name": "services.tags.category",
"type": "string"
},
{
"count_unit": "service",
"name": "services.http.capabilities",
"type": "string"
}
],
"dataset": "hosts",
"language": "infraql",
"query_fields": [
{
"description": "Two-letter country code.",
"name": "country_code",
"operators": [
":",
"=",
"!="
],
"type": "string"
}
]
},
{
"aggregate_fields": [
{
"count_unit": "service",
"name": "port",
"type": "integer"
},
{
"count_unit": "service",
"name": "tags",
"type": "string"
},
{
"count_unit": "host",
"name": "tags.category",
"type": "string"
},
{
"count_unit": "service",
"name": "http.capabilities",
"type": "string"
}
],
"dataset": "services",
"language": "infraql",
"query_fields": [
{
"description": "Observed service port.",
"name": "port",
"operators": [
":",
"=",
"!=",
"<",
"<=",
">",
">="
],
"type": "integer"
}
]
},
{
"aggregate_fields": [
{
"count_unit": "dns_record",
"name": "record_type",
"type": "string"
},
{
"count_unit": "dns_record",
"name": "host",
"type": "string"
},
{
"count_unit": "dns_record",
"name": "apex_domain",
"type": "string"
},
{
"count_unit": "dns_record",
"name": "rcode",
"type": "string"
},
{
"count_unit": "dns_record",
"name": "answer",
"type": "string"
}
],
"dataset": "dns",
"language": "infraql",
"query_fields": [
{
"description": "DNS record type.",
"name": "dns.type",
"operators": [
":",
"=",
"!="
],
"type": "string"
}
]
},
{
"aggregate_fields": [
{
"count_unit": "whois_domain",
"name": "whois.registrar",
"type": "string"
},
{
"count_unit": "whois_domain",
"name": "whois.status",
"type": "string"
},
{
"count_unit": "whois_domain",
"name": "whois.dnssec",
"type": "string"
},
{
"count_unit": "whois_domain",
"name": "whois.nameserver",
"type": "string"
},
{
"count_unit": "whois_domain",
"name": "whois.registrant.country",
"type": "string"
}
],
"dataset": "whois",
"language": "infraql",
"query_fields": [
{
"description": "Sponsoring registrar name.",
"name": "whois.registrar",
"operators": [
":",
"=",
"!="
],
"type": "string"
}
]
},
{
"aggregate_fields": [
{
"count_unit": "certificate",
"name": "certificate.not_before",
"type": "integer"
},
{
"count_unit": "certificate",
"name": "certificate.signature_algorithm",
"type": "string"
},
{
"count_unit": "certificate",
"name": "certificate.is_ca",
"type": "boolean"
},
{
"count_unit": "certificate",
"name": "certificate.registrable_domains",
"type": "string"
}
],
"dataset": "certificates",
"language": "infraql",
"query_fields": [
{
"description": "Lowercase certificate SHA-256.",
"name": "certificate.sha256",
"operators": [
"="
],
"type": "string"
}
]
}
]
}Search
Schema
Returns the hosts, services, DNS, and certificates v1 dataset schemas in deterministic order. Clients should select entries by dataset rather than rely on array position. Existing per-dataset schema endpoints remain available.
GET
https://api.infrawatch.com/api/v1
/
search
/
schema
Schema
curl --request GET \
--url https://api.infrawatch.com/api/v1/search/schema \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.infrawatch.com/api/v1/search/schema"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.infrawatch.com/api/v1/search/schema', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.infrawatch.com/api/v1/search/schema"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"schemas": [
{
"aggregate_fields": [
{
"count_unit": "host",
"name": "country_code",
"type": "string"
},
{
"count_unit": "host",
"name": "tags",
"type": "string"
},
{
"count_unit": "service",
"name": "services.tags",
"type": "string"
},
{
"count_unit": "host",
"name": "services.tags.category",
"type": "string"
},
{
"count_unit": "service",
"name": "services.http.capabilities",
"type": "string"
}
],
"dataset": "hosts",
"language": "infraql",
"query_fields": [
{
"description": "Two-letter country code.",
"name": "country_code",
"operators": [
":",
"=",
"!="
],
"type": "string"
}
]
},
{
"aggregate_fields": [
{
"count_unit": "service",
"name": "port",
"type": "integer"
},
{
"count_unit": "service",
"name": "tags",
"type": "string"
},
{
"count_unit": "host",
"name": "tags.category",
"type": "string"
},
{
"count_unit": "service",
"name": "http.capabilities",
"type": "string"
}
],
"dataset": "services",
"language": "infraql",
"query_fields": [
{
"description": "Observed service port.",
"name": "port",
"operators": [
":",
"=",
"!=",
"<",
"<=",
">",
">="
],
"type": "integer"
}
]
},
{
"aggregate_fields": [
{
"count_unit": "dns_record",
"name": "record_type",
"type": "string"
},
{
"count_unit": "dns_record",
"name": "host",
"type": "string"
},
{
"count_unit": "dns_record",
"name": "apex_domain",
"type": "string"
},
{
"count_unit": "dns_record",
"name": "rcode",
"type": "string"
},
{
"count_unit": "dns_record",
"name": "answer",
"type": "string"
}
],
"dataset": "dns",
"language": "infraql",
"query_fields": [
{
"description": "DNS record type.",
"name": "dns.type",
"operators": [
":",
"=",
"!="
],
"type": "string"
}
]
},
{
"aggregate_fields": [
{
"count_unit": "whois_domain",
"name": "whois.registrar",
"type": "string"
},
{
"count_unit": "whois_domain",
"name": "whois.status",
"type": "string"
},
{
"count_unit": "whois_domain",
"name": "whois.dnssec",
"type": "string"
},
{
"count_unit": "whois_domain",
"name": "whois.nameserver",
"type": "string"
},
{
"count_unit": "whois_domain",
"name": "whois.registrant.country",
"type": "string"
}
],
"dataset": "whois",
"language": "infraql",
"query_fields": [
{
"description": "Sponsoring registrar name.",
"name": "whois.registrar",
"operators": [
":",
"=",
"!="
],
"type": "string"
}
]
},
{
"aggregate_fields": [
{
"count_unit": "certificate",
"name": "certificate.not_before",
"type": "integer"
},
{
"count_unit": "certificate",
"name": "certificate.signature_algorithm",
"type": "string"
},
{
"count_unit": "certificate",
"name": "certificate.is_ca",
"type": "boolean"
},
{
"count_unit": "certificate",
"name": "certificate.registrable_domains",
"type": "string"
}
],
"dataset": "certificates",
"language": "infraql",
"query_fields": [
{
"description": "Lowercase certificate SHA-256.",
"name": "certificate.sha256",
"operators": [
"="
],
"type": "string"
}
]
}
]
}Authorizations
Infrawatch API key. Supply the complete key directly as the header value.
Response
Public query schemas for every v1 dataset. The complete encoded JSON response is limited to 15 MiB (15728640 bytes).
Closed catalog containing exactly one schema for each v1 dataset. The complete encoded JSON response is limited to 15 MiB (15728640 bytes).
Exactly one schema for each v1 dataset. The deterministic response order is hosts, services, DNS, WHOIS, then certificates; clients should select entries by dataset rather than rely on array position.
Required array length:
5 elementsShow child attributes
Show child attributes
⌘I