Comprehensive API documentation for launching and managing stress tests programmatically.
All API requests require an API key. You can find your API key in your account dashboard. Pass it using one of these methods:
| Method | Format |
|---|---|
Query Parameter |
?api_key=YOUR_API_KEY |
Authorization Header |
Authorization: Bearer YOUR_API_KEY |
JSON Body |
{"api_key": "YOUR_API_KEY"} |
| Parameter | Type | Status | Description |
|---|---|---|---|
api_key |
string | Required | Your API key |
host |
string | Required | Target IP address or hostname |
port |
integer | Required | Target port (e.g. 80, 443) |
time |
integer | Required | Attack duration in seconds. Alias: duration |
method |
string | Required | Attack method (see list below) |
concurrent |
integer | Optional | Number of concurrent attacks (default: 1) |
Returns a list of currently running attacks for the authenticated user.
Use the method parameter value (left column) in your API requests.