REST API v1
Search
The Search endpoint allows you to find if an IP address, CIDR notation or ASN has been active in a Dataplane.org Signal within the past seven (7) days. The feature is intended to be a periodic check and is not a substitute for utilizing Signals directly.
Rate limit
The endpoint has a rate limit as it is a public interface of 10 requests per minute.
Response
Status: 429 Too Many Requests
{
"success": false,
"error": "Too many requests, please try again later."
}
Code Samples
Shell
IP Address
curl https://api.dataplane.org/v1/search/127.0.0.1
Response
Status: 200 OK
{
"success": true,
"data": {
"searchednet": "127.0.0.1",
"foundaddress": "127.0.0.1",
"foundasn": "None",
"foundasdesc": "None",
"lastseen": "2022-01-21 1:12:29",
"reportname": "IP Addresses identified as attempting SSH password authentication.",
"reporturls": ["https://dataplane.org/signals/sshpwauth.txt"]
}
}
CIDR notation
curl https://api.dataplane.org/v1/search/127.0.0.0/24
Response
Status: 200 OK
{
"success": true,
"data": {
"searchednet": "127.0.0.0/24",
"foundaddress": "127.0.0.1",
"foundasn": "None",
"foundasdesc": "None",
"lastseen": "2022-01-21 1:12:29",
"reportname": "IP Addresses identified as attempting SSH password authentication.",
"reporturls": ["https://dataplane.org/signals/sshpwauth.txt"]
}
}
ASN
curl https://api.dataplane.org/v1/search/64512
Response
Status: 200 OK
{
"success": true,
"data": {
"searchednet": "64512",
"foundaddress": "127.0.0.1",
"foundasn": "None",
"foundasdesc": "None",
"lastseen": "2022-01-21 1:12:29",
"reportname": "IP Addresses identified as attempting SSH password authentication.",
"reporturls": ["https://dataplane.org/signals/sshpwauth.txt"]
}
Invalid ASN, IPv4 Address or IPv6 Address.
Response
Status: 422 Unprocessable Entity
{
"success": false,
"error": "Invalid ASN, IPv4 Address or IPv6 Address."
}
Invalid CIDR block.
Response
Status: 422 Unprocessable Entity
{
"success": false,
"error": "Invalid CIDR block."
}
Service Unavailable
Response
Status: 503 Service Unavailable
{
"success": false,
"error": "Error with service, please try again later."
}
No matches found
Response
Status: 404 Not Found
{
"success": false,
"error": "No data found."
}