Skip to content
TunnelHQTunnelHQ Docs

Overview

Open in ChatGPTOpen in Claude

TunnelHQ API v1

Section titled “TunnelHQ API v1”

Manage VPN monitors, run on-demand tests, and read results and incidents over HTTP.

Every request is authenticated with an API key, sent as X-API-Key: <key> or Authorization: Bearer <key>. Endpoints that work inside one project also need the X-Project-Id header. IDs carry a prefix (srv_42 for a monitor, prj_12 for a project, inc_7 for an incident); anywhere an ID is accepted, the bare number works too.

Errors return {"error": true, "code": <status>, "message": "…"}, except usage-limit errors, which use their own shape (see TooManyRequests).

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “ Operations ”
GET
/servers
POST
/servers
GET
/servers/search
GET
/servers/{id}
PUT
/servers/{id}
DELETE
/servers/{id}
POST
/test
POST
/test/batch
POST
/check
GET
/results
GET
/results/failures
GET
/results/server/{id}
GET
/incidents
GET
/incidents/{id}
GET
/incidents/{id}/events
POST
/incidents/{id}/acknowledge
POST
/incidents/{id}/retest
GET
/subscriptions
POST
/subscriptions
GET
/subscriptions/{id}
PUT
/subscriptions/{id}
DELETE
/subscriptions/{id}
POST
/subscriptions/{id}/sync
GET
/whoami
GET
/organizations
GET
/projects
GET
/usage
GET
/keys
POST
/keys
DELETE
/keys/{id}
GET
/health
GET
/health/deep
GET
/regions
POST
/check/public

Authentication

Section titled “ Authentication ”

ApiKeyHeader

Section titled “ApiKeyHeader”

Your API key. Create one under Developers → API Keys.

Security scheme type: apiKey

Header parameter name: X-API-Key

BearerAuth

Section titled “BearerAuth”

The same API key, sent as Authorization: Bearer <key>.

Security scheme type: http