API Reference
Launch and manage attacks with the Overtime API. Start attacks, view ongoing attacks and check who is online from one endpoint set.
All requests return JSON. Make requests from your server, never from a public client, so your API key stays private.
Introduction
Every request goes to your API base URL and returns JSON.
BASE
https://endpoint.overtime.ukAuthentication
Authentication is done per request using query parameters on /api/start. Supply your account username and API key. Your server IP must also be whitelisted on the account.
| Parameter | Type | Description |
|---|---|---|
| username | string | Your account username. |
| key | string | Your API key. |
Start an attack
Launch an attack against a target. Method availability, duration limits, cooldowns and concurrent slots depend on your plan and addons.
GET
/api/start| Parameter | Type | Description |
|---|---|---|
| username | string | Your account username. |
| key | string | Your API key. |
| target | string | Target IP, host or URL depending on method type (L4 requires an IP). |
| port | integer | Target port. |
| time | integer | Attack duration in seconds, up to your plan's max time. |
| method | string | Attack method to use. |
GET /api/start?username=USER&key=KEY&target=1.1.1.1&port=80&time=60&method=UDP
{
"status": "success",
"id": "a1b2c3",
"message": "Attack started"
}
Ongoing attacks
List every attack currently running on your account.
GET
/api/ongoing| Parameter | Type | Description |
|---|---|---|
| username | string | Your account username. |
| key | string | Your API key. |
{
"ongoing": [
{ "id": "a1b2c3", "target": "1.1.1.1", "method": "UDP", "remaining": 42 }
]
}
Online users
Return the number of users currently online on the network.
GET
/api/online{ "online": 128 }
Errors
Errors return a non-success status with a human-readable message.
| Status | Type | Description |
|---|---|---|
| invalid_key | error | Username or API key is wrong. |
| not_whitelisted | error | Request IP is not whitelisted on the account. |
| cooldown | error | Your plan's cooldown has not elapsed yet. |
| slots_full | error | All concurrent attack slots are in use. |