Phisherman

Reporting a caught phish PUT

When integrating the Phisherman checks with your Discord bot, you can optionally report back when it catches a phish in your server(s).

TIP

Reporting back caught phish is entirely optional and not required for normal usage, it purely helps us with our analytics

🔒 Auth Token: Required
🔑 API Permission Required: API.UPDATE

The URL for this endpoint is:

https://api.phisherman.gg/v1/domains/<domain>

Required Parameters

NameTypeDescription
domainstringThe fully qualified domain name of the phish you caught

Optional Parameters

NameTypeDescription
guildintegerThe Discord ID of the Guild this phish was found in

Example Requests

curl -L -X PUT "https://api.phisherman.gg/v1/domains/verified.test.phisherman.gg" \
-H "Authorization: Bearer <API-KEY>" \
-H "Content-Type: application/json" \
--data-raw "{
    \"guild\": 878130674844979210
}"
1
2
3
4
5
6
var myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer <API-KEY>");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
  "guild": 878130674844979200
});

var requestOptions = {
  method: 'PUT',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://api.phisherman.gg/v1/domains/verified.test.phisherman.gg", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
import http.client
import json

conn = http.client.HTTPSConnection("api.phisherman.gg")
payload = json.dumps({
  "guild": 878130674844979200
})
headers = {
  'Authorization': 'Bearer <API-KEY>',
  'Content-Type': 'application/json'
}
conn.request("PUT", "/v1/domains/verified.test.phisherman.gg", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

Example Response

HTTP2/204
1
Last Updated: