Network Peerings

Network peerings enable connectivity between private networks in different zones. This allows servers in different geographical locations to communicate over a private, secure connection.

Peerings require networks in both zones to have routers attached. Once established, traffic flows directly between the networks without traversing the public internet.

GET/1.3/network-peering

List peerings

Returns a list of all network peerings accessible to the account.

Query parameters

Name
label
Type
string
Description
Filter by label (e.g., ?label=env=prod).

Request

GET

/1.3/network-peering

curl -X GET https://api.upcloud.com/1.3/network-peering \
  -u your_username:your_password

GET/1.3/network-peering/{uuid}

Get peering details

Returns detailed information about a specific network peering.

Request

GET

/1.3/network-peering/{uuid}

curl -X GET https://api.upcloud.com/1.3/network-peering/0f3c1234-2658-4b0c-8ac7-962090f4e92a \
  -u your_username:your_password

POST/1.3/network-peering

Create peering

Creates a new network peering between two private networks in different zones.

Both networks must have routers attached for the peering to become active.

Attributes

Name
name
Type
string
Description
Peering name. Required.
Name
configured_status
Type
string
Description
Desired status: "active" or "disabled". Default: "active".
Name
network
Type
object
Description
Local network configuration. Required.
Name
peer_network
Type
object
Description
Peer network configuration. Required.
Name
labels
Type
array
Description
Labels for classification.

Request

POST

/1.3/network-peering

curl -X POST https://api.upcloud.com/1.3/network-peering \
  -u your_username:your_password \
  -H "Content-Type: application/json" \
  -d '{
    "network_peering": {
      "name": "Helsinki-Frankfurt Peering",
      "configured_status": "active",
      "network": {
        "uuid": "034c12bc-cf15-4b19-97b2-0ab4e51bb98d"
      },
      "peer_network": {
        "uuid": "03abc123-cf15-4b19-97b2-0ab4e51bb98d"
      },
      "labels": [
        {"key": "region", "value": "eu"}
      ]
    }
  }'

PATCH/1.3/network-peering/{uuid}

Modify peering

Modifies an existing network peering. You can update the name, status, or labels.

Request

PATCH

/1.3/network-peering/{uuid}

curl -X PATCH https://api.upcloud.com/1.3/network-peering/0f3c1234-2658-4b0c-8ac7-962090f4e92a \
  -u your_username:your_password \
  -H "Content-Type: application/json" \
  -d '{
    "network_peering": {
      "name": "Updated Peering Name",
      "configured_status": "disabled"
    }
  }'

DELETE/1.3/network-peering/{uuid}

Delete peering

Deletes a network peering. This will disconnect the two networks.

Request

DELETE

/1.3/network-peering/{uuid}

curl -X DELETE https://api.upcloud.com/1.3/network-peering/0f3c1234-2658-4b0c-8ac7-962090f4e92a \
  -u your_username:your_password