Update Scanner

PATCH

https://oathnet.org/api

scanners

{scanner_uid}

update

Update Scanner

curl --request PATCH \
  --url https://oathnet.org/api/scanners/{scanner_uid}/update \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "query_config": {
    "q": "alice@example.com",
    "email": "alice@example.com",
    "dbname[]": [
      "linkedin.com",
      "twitter.com"
    ],
    "wildcard": true,
    "extra_params": {
      "sort": "-indexed_at"
    }
  },
  "webhook_url": "<string>",
  "webhook_secret": "<string>",
  "notify_on_zero_results": true
}
'

import requests

url = "https://oathnet.org/api/scanners/{scanner_uid}/update"

payload = {
    "name": "<string>",
    "query_config": {
        "q": "alice@example.com",
        "email": "alice@example.com",
        "dbname[]": ["linkedin.com", "twitter.com"],
        "wildcard": True,
        "extra_params": { "sort": "-indexed_at" }
    },
    "webhook_url": "<string>",
    "webhook_secret": "<string>",
    "notify_on_zero_results": True
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    query_config: {
      q: 'alice@example.com',
      email: 'alice@example.com',
      'dbname[]': ['linkedin.com', 'twitter.com'],
      wildcard: true,
      extra_params: {sort: '-indexed_at'}
    },
    webhook_url: '<string>',
    webhook_secret: '<string>',
    notify_on_zero_results: true
  })
};

fetch('https://oathnet.org/api/scanners/{scanner_uid}/update', 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/{scanner_uid}/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'query_config' => [
        'q' => 'alice@example.com',
        'email' => 'alice@example.com',
        'dbname[]' => [
                'linkedin.com',
                'twitter.com'
        ],
        'wildcard' => true,
        'extra_params' => [
                'sort' => '-indexed_at'
        ]
    ],
    '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/{scanner_uid}/update"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\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  \"webhook_url\": \"<string>\",\n  \"webhook_secret\": \"<string>\",\n  \"notify_on_zero_results\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://oathnet.org/api/scanners/{scanner_uid}/update")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\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  \"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/{scanner_uid}/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\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  \"webhook_url\": \"<string>\",\n  \"webhook_secret\": \"<string>\",\n  \"notify_on_zero_results\": true\n}"

response = http.request(request)
puts response.read_body

{
  "uid": "<string>",
  "user": "<string>",
  "name": "<string>",
  "scanner_type_display": "<string>",
  "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_display": "<string>",
  "webhook_url": "<string>",
  "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
}

Authorizations

x-api-key

string

header

required

API key for authentication (lowercase header name)

Path Parameters

scanner_uid

string

required

Body

application/json

Partial scanner update. Runtime-only search params are rejected inside query_config.

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.

Show child attributes

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 | null

webhook_secret

string

webhook_security_mode

enum<string>

api_key is only available on existing scanners.

Available options:

api_key,

signed_json,

signed_encrypted

notify_on_zero_results

boolean

Response

200 - 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.

Show child attributes

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 | null

webhook_security_mode

enum<string>

api_key is only available on existing scanners. New webhook scanners should use signed_json or signed_encrypted.

Available options:

api_key,

signed_json,

signed_encrypted

webhook_secret_last_rotated_at

string<date-time> | null

notify_on_zero_results

boolean

created_at

string<date-time>

updated_at

string<date-time>

last_run_at

string<date-time> | null

last_found_at

string<date-time> | null

next_run_at

string<date-time> | null

total_results_found

integer

total_runs

integer

consecutive_failures

integer

Update Scanner

curl --request PATCH \
  --url https://oathnet.org/api/scanners/{scanner_uid}/update \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "query_config": {
    "q": "alice@example.com",
    "email": "alice@example.com",
    "dbname[]": [
      "linkedin.com",
      "twitter.com"
    ],
    "wildcard": true,
    "extra_params": {
      "sort": "-indexed_at"
    }
  },
  "webhook_url": "<string>",
  "webhook_secret": "<string>",
  "notify_on_zero_results": true
}
'

import requests

url = "https://oathnet.org/api/scanners/{scanner_uid}/update"

payload = {
    "name": "<string>",
    "query_config": {
        "q": "alice@example.com",
        "email": "alice@example.com",
        "dbname[]": ["linkedin.com", "twitter.com"],
        "wildcard": True,
        "extra_params": { "sort": "-indexed_at" }
    },
    "webhook_url": "<string>",
    "webhook_secret": "<string>",
    "notify_on_zero_results": True
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    query_config: {
      q: 'alice@example.com',
      email: 'alice@example.com',
      'dbname[]': ['linkedin.com', 'twitter.com'],
      wildcard: true,
      extra_params: {sort: '-indexed_at'}
    },
    webhook_url: '<string>',
    webhook_secret: '<string>',
    notify_on_zero_results: true
  })
};

fetch('https://oathnet.org/api/scanners/{scanner_uid}/update', 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/{scanner_uid}/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'query_config' => [
        'q' => 'alice@example.com',
        'email' => 'alice@example.com',
        'dbname[]' => [
                'linkedin.com',
                'twitter.com'
        ],
        'wildcard' => true,
        'extra_params' => [
                'sort' => '-indexed_at'
        ]
    ],
    '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/{scanner_uid}/update"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\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  \"webhook_url\": \"<string>\",\n  \"webhook_secret\": \"<string>\",\n  \"notify_on_zero_results\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://oathnet.org/api/scanners/{scanner_uid}/update")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\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  \"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/{scanner_uid}/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\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  \"webhook_url\": \"<string>\",\n  \"webhook_secret\": \"<string>\",\n  \"notify_on_zero_results\": true\n}"

response = http.request(request)
puts response.read_body

{
  "uid": "<string>",
  "user": "<string>",
  "name": "<string>",
  "scanner_type_display": "<string>",
  "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_display": "<string>",
  "webhook_url": "<string>",
  "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
}

Overview

Endpoints

Authorizations

Path Parameters

Body

Response