gateway

Modify Connection

Modify connection configuration.

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

Request

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

Request body

uuidstring uuid

The unique identifier for the resource.

namestring

Name of the connection

type'ipsec'

Connection type

Example request

{
  "uuid": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "gateway-service",
  "type": "ipsec",
  "local_routes": [
    {
      "name": "modified-routes",
      "type": "static",
      "static_network": "10.0.22.0/24"
    }
  ]
}

Response

OK

uuidstring uuid

The unique identifier for the resource.

namestring

Name of the connection

type'ipsec'

Connection type

created_atstring date-time

Timestamp of when the connection was created.

updated_atstring date-time

Timestamp of when the connection was last updated.

Example response

{
  "uuid": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "gateway-service",
  "type": "ipsec",
  "local_routes": [],
  "remote_routes": [],
  "tunnels": [],
  "created_at": "2025-03-26T12:34:56Z",
  "updated_at": "2025-03-26T12:34:56Z"
}

Changes

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