Bulk Report Detections POST

For public bots that serve a large number of guilds, Phisherman offers a bulk reporting endpoint to help reduce the number of API calls made.

TIP

Reporting detections is entirely optional and not required for normal usage, though it does help us with our analytics and allows you to see how many phish you have stopped.

Request

What you send to the API.

Authentication

🔒 API Key: Required
🔑 API Permission Required: API.UPDATE_BULK

Provide your API key in the Authorization header when making requests.

Example

"Authorization": "Bearer 04eff65e-309c-1a2b-cde3-4567f8901gh"

The URL for this endpoint is:

https://api.phisherman.gg/v2/phish/caught/bulk

Body

The JSON payload for this endpoint uses the end-user API key as the object key, followed by the full URL of the phish, and then an array of timestamps.

This allows the end user to view the number of Phish they have caught in the dashboard

{
	"<USER#1-API-KEY>": {
		"https://internetbadguys.com/random-page-url": [1635591332, 1635592459],
		"https://malicious.test.phisherman.gg": [1635591332]
	},
	"<USER#2-API-KEY>": {
		"https://internetbadguys.com/random-page-url": [1635591332, 1635592459],
		"https://malicious.test.phisherman.gg": [1635591332]
	}
}

Examples

CURL

curl -L -X POST "https://api.phisherman.gg/v2/phish/caught/bulk" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 04eff65e-309c-1a2b-cde3-4567f8901gh" \
--data-raw "{
    \"<USER#1-API-KEY>\": {
        \"https://internetbadguys.com/random-page-url\": [
            1635591332,
            1635592459
        ],
        \"https://malicious.test.phisherman.gg\": [
            1635591332
        ]
    },
    \"<USER#2-API-KEY>\": {
        \"https://internetbadguys.com/random-page-url\": [
            1635591332,
            1635592459
        ],
        \"https://malicious.test.phisherman.gg\": [
            1635591332
        ]
    }
}"

JavaScript

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer 04eff65e-309c-1a2b-cde3-4567f8901gh");

var raw = JSON.stringify({
	"<USER#1-API-KEY>": {
		"https://internetbadguys.com/random-page-url": [1635591332, 1635592459],
		"https://malicious.test.phisherman.gg": [1635591332],
	},
	"<USER#2-API-KEY>": {
		"https://internetbadguys.com/random-page-url": [1635591332, 1635592459],
		"https://malicious.test.phisherman.gg": [1635591332],
	},
});

var requestOptions = {
	method: "POST",
	headers: myHeaders,
	body: raw,
	redirect: "follow",
};

fetch("https://api.phisherman.gg/v2/phish/caught/bulk", requestOptions)
	.then(response => response.text())
	.then(result => console.log(result))
	.catch(error => console.log("error", error));

Python

import http.client
import json

conn = http.client.HTTPSConnection("api.phisherman.gg")
payload = json.dumps({
  "<USER#1-API-KEY>": {
    "https://internetbadguys.com/random-page-url": [
      1635591332,
      1635592459
    ],
    "https://malicious.test.phisherman.gg": [
      1635591332
    ]
  },
  "<USER#2-API-KEY>": {
    "https://internetbadguys.com/random-page-url": [
      1635591332,
      1635592459
    ],
    "https://malicious.test.phisherman.gg": [
      1635591332
    ]
  }
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer 04eff65e-309c-1a2b-cde3-4567f8901gh'
}
conn.request("POST", "/v2/phish/caught/bulk", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Response

Report A Detection response

HTTP 201

{
	"message": "Success",
	"data": {
		"detections_count": <NUMBER OF DETECTIONS>
	}
}

HTTP 400

{
	"message": <ERROR-MESSAGE>,
}

HTTP 500

{
	"message": <ERROR-MESSAGE>,
}