gateway

List Tunnels

List available tunnels for service.

get/1.3/gateway/{service-uuid}/connections/{connection-uuid}/tunnels

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/gateway/{service-uuid}/connections/{connection-uuid}/tunnels
  • Auth: HTTP bearer

Path parameters

service-uuidstring uuid required

The unique identifier for the resource.

Example:01234567-89ab-cdef-0123-456789abcdef

Service UUID

connection-uuidstring uuid required

The unique identifier for the resource.

Example:01234567-89ab-cdef-0123-456789abcdef

Connection UUID

Response

OK

uuidstring uuid

The unique identifier for the resource.

namestring

Name of the tunnel

internal_peer_ping_intervalinteger

Internal peer ping interval in seconds

operational_state'idle' | 'connecting' | 'established' | 'destroying' | 'unknown'

Tunnel operational state

created_atstring date-time

Timestamp of when the tunnel was created.

updated_atstring date-time

Timestamp of when the tunnel was last updated.

tunnel_upboolean

Indicates whether the tunnel is up

tunnel_healthyboolean

Indicates whether the tunnel is healthy

Example response

[]

Changes

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