Skip to content
TunnelHQ Docs
Search
Ctrl
K
Cancel
tunnelhq.com
Dashboard
Select theme
Dark
Light
Auto
Menu
Welcome
FAQ
Tunnels
Get started
Working with monitors
Import and subscription URLs
Locations and status
Protocols
Overview
WireGuard
AmneziaWG
OpenVPN
OpenConnect
IKEv2
V2Ray / Xray protocols
Incidents
How incidents work
Alerts and integrations
Alert channels
Webhooks
Developers
Getting an API key
REST API
API reference
Overview
Monitors
Overview
List monitors
GET
Create monitor
POST
Search monitors
GET
Get monitor
GET
Update monitor
PUT
Delete monitor
DELETE
Tests
Overview
Run a test
POST
Run tests on several monitors
POST
Check a config
POST
Results
Overview
List results
GET
List failed checks
GET
List a monitor's results
GET
Incidents
Overview
List incidents
GET
Get incident
GET
List an incident's activity
GET
Acknowledge incident
POST
Retest an incident's monitor
POST
Subscriptions
Overview
List subscriptions
GET
Add subscription
POST
Get subscription
GET
Update subscription
PUT
Delete subscription
DELETE
Sync subscription now
POST
Account
Overview
Get the key's owner and scope
GET
List workspaces
GET
List projects
GET
Get API usage
GET
Keys
Overview
List your API keys
GET
Create an API key
POST
Disable or delete an API key
DELETE
Public
Overview
Check the API is up
GET
Check the API and its storage
GET
List regions
GET
Check a config without a key
POST
CLI
MCP server
Account
Team and roles
tunnelhq.com
Dashboard
Select theme
Dark
Light
Auto
Overview
Open in ChatGPT
Open in Claude
Incidents
Section titled “Incidents”
Incidents and their activity log.
Operations
Section titled “ Operations ”
GET
/incidents
GET
/incidents/{id}
GET
/incidents/{id}/events
POST
/incidents/{id}/acknowledge
POST
/incidents/{id}/retest