Skip to main content
POST
/
scanners
/
create
Create Scanner
curl --request POST \
  --url https://oathnet.org/api/scanners/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "scanner_type": "stealer",
  "query_config": {
    "q": "alice@example.com",
    "email": "alice@example.com",
    "dbname[]": [
      "linkedin.com",
      "twitter.com"
    ],
    "wildcard": true,
    "extra_params": {
      "sort": "-indexed_at"
    }
  },
  "notification_type": "email",
  "webhook_url": "<string>",
  "webhook_secret": "<string>",
  "webhook_security_mode": "api_key",
  "notify_on_zero_results": true
}
'
{
  "uid": "<string>",
  "user": "<string>",
  "name": "<string>",
  "scanner_type": "stealer",
  "scanner_type_display": "<string>",
  "status": "active",
  "status_display": "<string>",
  "query_config": {
    "q": "alice@example.com",
    "email": "alice@example.com",
    "dbname[]": [
      "linkedin.com",
      "twitter.com"
    ],
    "wildcard": true,
    "extra_params": {
      "sort": "-indexed_at"
    }
  },
  "notification_type": "email",
  "notification_type_display": "<string>",
  "webhook_url": "<string>",
  "webhook_security_mode": "api_key",
  "webhook_secret_last_rotated_at": "2023-11-07T05:31:56Z",
  "notify_on_zero_results": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "last_run_at": "2023-11-07T05:31:56Z",
  "last_found_at": "2023-11-07T05:31:56Z",
  "next_run_at": "2023-11-07T05:31:56Z",
  "total_results_found": 123,
  "total_runs": 123,
  "consecutive_failures": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.oathnet.org/llms.txt

Use this file to discover all available pages before exploring further.

Create a new stealer or breach scanner.
API-key access for scanner management is available today. Successful creation returns the raw scanner object.

Authorizations

​
x-api-key
string
header
required

API key for authentication (lowercase header name)

Body

application/json
​
name
string
​
scanner_type
enum<string>
Available options:
stealer,
breach
​
query_config
object

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.

Example:
{
  "q": "alice@example.com",
  "email": "alice@example.com",
  "dbname[]": ["linkedin.com", "twitter.com"],
  "wildcard": true,
  "extra_params": { "sort": "-indexed_at" }
}
​
notification_type
enum<string>
Available options:
email,
webhook,
discord
​
webhook_url
string
​
webhook_secret
string
​
webhook_security_mode
enum<string>
Available options:
api_key,
signed_json,
signed_encrypted
​
notify_on_zero_results
boolean

Response

201 - application/json

Raw scanner object

​
uid
string
​
user
string
​
name
string
​
scanner_type
enum<string>
Available options:
stealer,
breach
​
scanner_type_display
string
​
status
enum<string>
Available options:
active,
paused,
disabled
​
status_display
string
​
query_config
object

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.

Example:
{
  "q": "alice@example.com",
  "email": "alice@example.com",
  "dbname[]": ["linkedin.com", "twitter.com"],
  "wildcard": true,
  "extra_params": { "sort": "-indexed_at" }
}
​
notification_type
enum<string>
Available options:
email,
webhook,
discord
​
notification_type_display
string
​
webhook_url
string
​
webhook_security_mode
enum<string>
Available options:
api_key,
signed_json,
signed_encrypted
​
webhook_secret_last_rotated_at
string<date-time>
​
notify_on_zero_results
boolean
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
last_run_at
string<date-time>
​
last_found_at
string<date-time>
​
next_run_at
string<date-time>
​
total_results_found
integer
​
total_runs
integer
​
consecutive_failures
integer