Scanners
Test Draft Scanner Delivery
POST
https://oathnet.org/api
/
scanners
/
test-delivery
Test Draft Scanner Delivery
curl --request POST \
--url https://oathnet.org/api/scanners/test-delivery \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"query_config": {
"q": "alice@example.com",
"email": "alice@example.com",
"dbname[]": [
"linkedin.com",
"twitter.com"
],
"wildcard": true,
"extra_params": {
"sort": "-indexed_at"
}
},
"name": "<string>",
"webhook_url": "<string>",
"webhook_secret": "<string>",
"notify_on_zero_results": true
}
'import requests
url = "https://oathnet.org/api/scanners/test-delivery"
payload = {
"query_config": {
"q": "alice@example.com",
"email": "alice@example.com",
"dbname[]": ["linkedin.com", "twitter.com"],
"wildcard": True,
"extra_params": { "sort": "-indexed_at" }
},
"name": "<string>",
"webhook_url": "<string>",
"webhook_secret": "<string>",
"notify_on_zero_results": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query_config: {
q: 'alice@example.com',
email: 'alice@example.com',
'dbname[]': ['linkedin.com', 'twitter.com'],
wildcard: true,
extra_params: {sort: '-indexed_at'}
},
name: '<string>',
webhook_url: '<string>',
webhook_secret: '<string>',
notify_on_zero_results: true
})
};
fetch('https://oathnet.org/api/scanners/test-delivery', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://oathnet.org/api/scanners/test-delivery",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query_config' => [
'q' => 'alice@example.com',
'email' => 'alice@example.com',
'dbname[]' => [
'linkedin.com',
'twitter.com'
],
'wildcard' => true,
'extra_params' => [
'sort' => '-indexed_at'
]
],
'name' => '<string>',
'webhook_url' => '<string>',
'webhook_secret' => '<string>',
'notify_on_zero_results' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://oathnet.org/api/scanners/test-delivery"
payload := strings.NewReader("{\n \"query_config\": {\n \"q\": \"alice@example.com\",\n \"email\": \"alice@example.com\",\n \"dbname[]\": [\n \"linkedin.com\",\n \"twitter.com\"\n ],\n \"wildcard\": true,\n \"extra_params\": {\n \"sort\": \"-indexed_at\"\n }\n },\n \"name\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"webhook_secret\": \"<string>\",\n \"notify_on_zero_results\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://oathnet.org/api/scanners/test-delivery")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query_config\": {\n \"q\": \"alice@example.com\",\n \"email\": \"alice@example.com\",\n \"dbname[]\": [\n \"linkedin.com\",\n \"twitter.com\"\n ],\n \"wildcard\": true,\n \"extra_params\": {\n \"sort\": \"-indexed_at\"\n }\n },\n \"name\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"webhook_secret\": \"<string>\",\n \"notify_on_zero_results\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://oathnet.org/api/scanners/test-delivery")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query_config\": {\n \"q\": \"alice@example.com\",\n \"email\": \"alice@example.com\",\n \"dbname[]\": [\n \"linkedin.com\",\n \"twitter.com\"\n ],\n \"wildcard\": true,\n \"extra_params\": {\n \"sort\": \"-indexed_at\"\n }\n },\n \"name\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"webhook_secret\": \"<string>\",\n \"notify_on_zero_results\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"notification_type": "<string>",
"target": "<string>",
"status_code": 123,
"message": "<string>",
"preview": {
"event_name": "<string>",
"search_url": "<string>",
"security_mode": "<string>",
"verification_method": "<string>",
"authorization_scheme": "<string>",
"encryption_enabled": true,
"header_names": [
"<string>"
],
"body_kind": "<string>",
"body_example": {}
},
"generated_webhook_secret": "<string>"
}Authorizations
API key for authentication (lowercase header name)
Body
application/json
Test an unsaved scanner. webhook_url is required for webhook/Discord
tests. The response may include a generated webhook secret for preview.
Available options:
stealer, breach Persistent scanner search definition.
Scanners reuse the same flat filters and structured filter grammar as V2 search,
but reject runtime-only params such as from, to, cursor, page_size, format,
debug, and search_id. Scanner runs always execute on indexed_at.
Show child attributes
Show child attributes
Example:
{
"q": "alice@example.com",
"email": "alice@example.com",
"dbname[]": ["linkedin.com", "twitter.com"],
"wildcard": true,
"extra_params": { "sort": "-indexed_at" }
}
Available options:
email, webhook, discord New webhook scanners should use signed_json or signed_encrypted.
Available options:
api_key, signed_json, signed_encrypted ⌘I
Test Draft Scanner Delivery
curl --request POST \
--url https://oathnet.org/api/scanners/test-delivery \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"query_config": {
"q": "alice@example.com",
"email": "alice@example.com",
"dbname[]": [
"linkedin.com",
"twitter.com"
],
"wildcard": true,
"extra_params": {
"sort": "-indexed_at"
}
},
"name": "<string>",
"webhook_url": "<string>",
"webhook_secret": "<string>",
"notify_on_zero_results": true
}
'import requests
url = "https://oathnet.org/api/scanners/test-delivery"
payload = {
"query_config": {
"q": "alice@example.com",
"email": "alice@example.com",
"dbname[]": ["linkedin.com", "twitter.com"],
"wildcard": True,
"extra_params": { "sort": "-indexed_at" }
},
"name": "<string>",
"webhook_url": "<string>",
"webhook_secret": "<string>",
"notify_on_zero_results": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query_config: {
q: 'alice@example.com',
email: 'alice@example.com',
'dbname[]': ['linkedin.com', 'twitter.com'],
wildcard: true,
extra_params: {sort: '-indexed_at'}
},
name: '<string>',
webhook_url: '<string>',
webhook_secret: '<string>',
notify_on_zero_results: true
})
};
fetch('https://oathnet.org/api/scanners/test-delivery', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://oathnet.org/api/scanners/test-delivery",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query_config' => [
'q' => 'alice@example.com',
'email' => 'alice@example.com',
'dbname[]' => [
'linkedin.com',
'twitter.com'
],
'wildcard' => true,
'extra_params' => [
'sort' => '-indexed_at'
]
],
'name' => '<string>',
'webhook_url' => '<string>',
'webhook_secret' => '<string>',
'notify_on_zero_results' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://oathnet.org/api/scanners/test-delivery"
payload := strings.NewReader("{\n \"query_config\": {\n \"q\": \"alice@example.com\",\n \"email\": \"alice@example.com\",\n \"dbname[]\": [\n \"linkedin.com\",\n \"twitter.com\"\n ],\n \"wildcard\": true,\n \"extra_params\": {\n \"sort\": \"-indexed_at\"\n }\n },\n \"name\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"webhook_secret\": \"<string>\",\n \"notify_on_zero_results\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://oathnet.org/api/scanners/test-delivery")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query_config\": {\n \"q\": \"alice@example.com\",\n \"email\": \"alice@example.com\",\n \"dbname[]\": [\n \"linkedin.com\",\n \"twitter.com\"\n ],\n \"wildcard\": true,\n \"extra_params\": {\n \"sort\": \"-indexed_at\"\n }\n },\n \"name\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"webhook_secret\": \"<string>\",\n \"notify_on_zero_results\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://oathnet.org/api/scanners/test-delivery")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query_config\": {\n \"q\": \"alice@example.com\",\n \"email\": \"alice@example.com\",\n \"dbname[]\": [\n \"linkedin.com\",\n \"twitter.com\"\n ],\n \"wildcard\": true,\n \"extra_params\": {\n \"sort\": \"-indexed_at\"\n }\n },\n \"name\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"webhook_secret\": \"<string>\",\n \"notify_on_zero_results\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"notification_type": "<string>",
"target": "<string>",
"status_code": 123,
"message": "<string>",
"preview": {
"event_name": "<string>",
"search_url": "<string>",
"security_mode": "<string>",
"verification_method": "<string>",
"authorization_scheme": "<string>",
"encryption_enabled": true,
"header_names": [
"<string>"
],
"body_kind": "<string>",
"body_example": {}
},
"generated_webhook_secret": "<string>"
}