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
Uptime
Beta
Get started
Working with checks
Check types
Website
Keyword
Ping
TCP port
DNS
Heartbeat
Groups
Servers
Servers
Incidents
How incidents work
Maintenance windows
AI SRE
AI SRE
Status pages
Status pages
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
Groups
Overview
List groups
GET
Create a group
POST
Rename a group
PUT
Delete a group
DELETE
Status pages
Overview
List status pages
GET
Create a status page
POST
Get a status page
GET
Delete a status page
DELETE
Update a status page
PATCH
Set the services a status page shows
PUT
Change many services on a status page
PATCH
Publish or unpublish a status page
POST
Set a custom domain
PUT
Check a custom domain
POST
Get the logo and icons from the website
POST
List a status page's incidents
GET
Post an incident
POST
Add an update to an incident
POST
Maintenance
Overview
List maintenance windows
GET
Plan a maintenance window
POST
Get a maintenance window
GET
Cancel a maintenance window
DELETE
Change a maintenance window
PATCH
End a maintenance window now
POST
Alert channels
Overview
List alert channels
GET
Get where a monitor's alerts go
GET
Set where a monitor's alerts go
PUT
Send a test alert
POST
Servers
Overview
List servers
GET
List server incidents
GET
Get the install command
GET
Make a new install key
POST
Get a server
GET
Rename a server, or set its group or tags
PUT
Remove a server
DELETE
Get the defaults for new servers
GET
Change the defaults for new servers
PUT
Update a server's agent
POST
Get a server's history
GET
Link a tunnel or check to a server
POST
Keep a tunnel or check away from a server
POST
Change a server's alerts
PATCH
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