Batch Analyze IPs
POST/ip/batch
The Batch Analyze IPs endpoint enables processing of large volumes of IP addresses asynchronously. This endpoint accepts various input formats and returns a job ID for tracking the analysis progress.
Features:
- Asynchronous Processing: Submit large lists of IP addresses for background processing.
- Multiple Input Formats: Submit data as JSON arrays, CSV files, or line-separated text.
- Job Tracking: Monitor processing status using the returned job ID.
Input Formats:
- JSON Array: Submit a JSON object containing an array of IP addresses.
- CSV Upload: Upload a CSV file with IP addresses in a single column (with header row).
- Line-Separated Text: Submit a plain text file with one IP address per line.
Example JSON Request:
{
"ips": [
"192.168.0.1",
"10.0.0.1",
"172.16.0.1"
]
}
Authentication & Security
- API Key: Access requires an API key in the request headers.
- ACL Rules: Optional IP-based access restrictions for enhanced security.
- No Query Parameters: All data is transmitted securely through headers or request body.
Payload Limits
- Maximum payload size: 3MB
Request
Responses
- 202
- 400
- 403
- 413
- 500
Batch job accepted for processing.
Bad Request. Either the request is improperly formatted, or contains invalid IP addresses.
Forbidden
Payload Too Large. The request exceeds the 3MB size limit.
Internal server error.