Run tests on several monitors
const url = 'https://app.tunnelhq.com/api/v1/test/batch';const options = { method: 'POST', headers: { 'X-Project-Id': 'prj_12', 'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json' }, body: '{"server_ids":["srv_42","srv_57"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://app.tunnelhq.com/api/v1/test/batch \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <X-API-Key>' \ --header 'X-Project-Id: prj_12' \ --data '{ "server_ids": [ "srv_42", "srv_57" ] }'Queues a test of each monitor and returns at once, without waiting for results. Needs a role that can edit monitors (Owner, Admin, or Manager). Each monitor tested uses one on-demand test from the plan’s monthly quota; the request is refused only when none is left.
Read the results with List a monitor’s results. successful and
failed count the tests queued, not their outcomes. The top-level batch_id is a label;
it can’t be looked up.
Need an API key? See Getting an API key.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters”The project, as prj_12 or 12. A workspace key can only reach its own workspace’s projects.
Example
prj_12Request Bodyrequired
Section titled “Request Bodyrequired”object
The monitors, as srv_42 or 42. Every one must be in the project.
Where to test from: any, or a lowercase country code such as pk. A country needs the
Pro plan or above. List regions shows the
locations available now.
What happens when the location has no checker available. any runs the test from the
general pool instead, and the response doesn’t say so; fail refuses it. Any other value
counts as any.
Example
{ "server_ids": [ "srv_42", "srv_57" ]}Responses
Section titled “ Responses ”The tests are queued, one queue job per protocol.
object
object
The queue job for this protocol.
Monitors queued for this protocol.
Why this protocol’s tests couldn’t be queued.
Monitors in the request.
Tests queued.
Tests that couldn’t be queued.
Example
{ "batch_id": "batch-1790346600000", "results": [ { "protocol": "wireguard", "batch_id": "batch-wireguard-1790346600000", "count": 1 }, { "protocol": "vless", "batch_id": "batch-vless-1790346600001", "count": 1 } ], "total": 2, "successful": 2, "failed": 0}Headers
Section titled “Headers”Requests the workspace’s plan allows per minute.
Requests left in the current minute.
Unix time, in seconds, when the current minute ends.
server_ids or region is invalid.
object
The HTTP status, repeated.
What went wrong.
More detail, on some errors.
Seconds to wait, on the 429 for wrong keys.
Examples
{ "error": true, "code": 400, "message": "Missing or invalid server_ids"}{ "error": true, "code": 400, "message": "Invalid region: \"germany\"."}The API key is missing, wrong, expired, switched off, or no longer valid.
object
The HTTP status, repeated.
What went wrong.
More detail, on some errors.
Seconds to wait, on the 429 for wrong keys.
Examples
{ "error": true, "code": 401, "message": "API key is required. Provide X-API-Key header or Authorization: Bearer <key>"}{ "error": true, "code": 401, "message": "Invalid or expired API key"}{ "error": true, "code": 401, "message": "API key has expired"}{ "error": true, "code": 401, "message": "API key owner account is inactive"}{ "error": true, "code": 401, "message": "This API key's workspace access has been removed"}Testing from a specific location needs the Pro plan or above.
object
The HTTP status, repeated.
What went wrong.
More detail, on some errors.
Seconds to wait, on the 429 for wrong keys.
Example
{ "error": true, "code": 402, "message": "Region targeting requires the Pro plan or above."}A monitor isn’t in the project, or the role or quota doesn’t allow it.
object
The HTTP status, repeated.
What went wrong.
More detail, on some errors.
Seconds to wait, on the 429 for wrong keys.
Examples
{ "error": true, "code": 403, "message": "Some servers are not accessible", "details": { "invalid": [ "srv_99" ] }}{ "error": true, "code": 403, "message": "This action requires edit permission — your role is read-only"}{ "error": true, "code": 403, "message": "Monthly on-demand test limit reached (50/50)"}No active project has this ID.
object
The HTTP status, repeated.
What went wrong.
More detail, on some errors.
Seconds to wait, on the 429 for wrong keys.
Example
{ "error": true, "code": 404, "message": "Project not found or inactive"}A usage limit was reached, or this IP address made too many requests with a wrong key.
Usage limits are per workspace and plan: per minute (Retry-After: 60), per day
(Retry-After: 3600), and per month (no Retry-After). They use their own body shape.
An IP address may send 10 wrong keys a minute; one more is allowed every 6 seconds. While
that allowance is used up, every request from the address is refused, even one with a
valid key.
object
Seconds to wait. Absent for the monthly limit.
object
The HTTP status, repeated.
What went wrong.
More detail, on some errors.
Seconds to wait, on the 429 for wrong keys.
Examples
{ "error": "Rate limit exceeded", "message": "Per-minute limit of 60 requests exceeded", "retry_after": 60}{ "error": "Daily limit exceeded", "message": "Daily limit of 25000 requests exceeded", "retry_after": 3600}{ "error": "Monthly limit exceeded", "message": "Monthly limit of 250000 requests exceeded"}{ "error": true, "code": 429, "message": "Too many failed API key attempts from this address. Wait a few seconds and try again.", "retry_after": 6}Headers
Section titled “Headers”Seconds to wait. 60 for the per-minute limit, 3600 for the daily limit, 6 after wrong keys. Absent for the monthly limit.
Something failed on TunnelHQ’s side.
object
The HTTP status, repeated.
What went wrong.
More detail, on some errors.
Seconds to wait, on the 429 for wrong keys.
Example
{ "error": true, "code": 500, "message": "Internal server error"}