Comprehensive REST API reference for launching and automating network stress tests directly in CI/CD, scripts, and applications.
All API requests require an active API key with IP whitelist authorization. You can generate your API key and configure whitelisted client IPs in your account profile. Authenticate requests using any of the following methods:
| Method | Format |
|---|---|
Authorization Header |
Authorization: Bearer YOUR_API_KEY |
Query Parameter |
?api_key=YOUR_API_KEY |
JSON Body |
{"api_key": "YOUR_API_KEY"} |
| Parameter | Type | Status | Description |
|---|---|---|---|
api_key |
string | Required | Your account API key |
host |
string | Required | Target IP address or domain URL |
port |
integer | Required | Target port (e.g. 80, 443, 25565) |
time |
integer | Required | Attack duration in seconds (alias: duration) |
method |
string | Required | Attack vector method identifier (see catalog below) |
concurrent |
integer | Optional | Number of concurrent attacks to launch (default: 1) |
Retrieve currently active attacks launched by your account in real-time.