gateway

Modify Tunnel

Modify tunnel configuration.

patch/1.3/gateway/{service-uuid}/connections/{connection-uuid}/tunnels/{tunnel-uuid}

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/gateway/{service-uuid}/connections/{connection-uuid}/tunnels/{tunnel-uuid}
  • 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

tunnel-uuidstring uuid required

The unique identifier for the resource.

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

Tunnel UUID

Request body

uuidstring uuid

The unique identifier for the resource.

namestring

Name of the tunnel

tunnel_internal_ipstring

Tunnel internal IP address, "" if disabled

internal_peer_ping_intervalinteger

Internal peer ping interval in seconds, or zero if disabled

Example request

{
  "uuid": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "gateway-service",
  "local_address": {
    "name": "gateway-service"
  },
  "remote_address": {
    "address": "203.0.113.10"
  },
  "ipsec": {
    "authentication": {
      "type": "psk",
      "psk": "MySecretPsk123"
    },
    "phase1_algorithms": [],
    "phase2_algorithms": [],
    "phase1_integrity_algorithms": [],
    "phase2_integrity_algorithms": [],
    "phase1_dh_group_numbers": [],
    "phase2_dh_group_numbers": []
  },
  "tunnel_internal_ip": "10.0.0.1",
  "internal_peer_ping_interval": 0
}

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

{
  "uuid": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "gateway-service",
  "internal_peer_ping_interval": 0,
  "operational_state": "established",
  "created_at": "2025-03-26T12:34:56Z",
  "updated_at": "2025-03-26T12:34:56Z",
  "tunnel_up": true,
  "tunnel_healthy": true
}

Changes

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