Admin > Tunnels

Retrieve tunnel health

Retrieve the health status of a tunnel. Requires a tenant-level API key.

get/api/v1/admin/tunnel/{tunnel_name}/health

Request

  • Base URL: https://your-tenant.tines.com
  • URL: https://your-tenant.tines.com/api/v1/admin/tunnel/{tunnel_name}/health
  • Auth: one of:
    • API key in header X-User-Token
    • HTTP bearer

Path parameters

tunnel_namestring required

Name of the tunnel

Response

Successful response

healthstring

Health of the tunnel. One of: Down, Healthy, Inactive, Degraded

Changes

No recorded changes to this operation across all 1 revision of this API.