Description
Retrieve the health status of tunnels. Note: A user must be an admin in order to access this endpoint i.e. a tenant-level API key is required.
Request
HTTP Method: GET
| Query Parameter | Description |
|---|---|
| tunnel_name | Required Include the name of your tunnel |
| per_page | Optional Set the number of results returned per page. |
| page | Optional Specify the page of results to return if there are multiple pages. Defaults to page 1. |
curl -X GET \
https://<<META.tenant.domain>>/api/v1/admin/tunnel/<<tunnel_name>>/health \
-H 'content-type: application/json' \
-H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'
Here tunnel_name is the name of your tunnel
Response
A successful request will return a JSON object describing the health of the Tunnel. There is more information about health statuses in our Tunnel FAQ page here : https://www.tines.com/docs/admin/tunnel/tunnel-faqs/
Field description
| Parameter | Description |
|---|---|
| health | The health of the tunnel. Accepted values: Down, Healthy, Inactive, Degraded |
| name | The team name. |
Sample response
{
"health": "Healthy"
}