network-peering

Create peering

Network peerings are used to enable traffic between two networks that can be on different main accounts. The peering must be established both ways before it's considered as active. Peering is only supported between networks of type private.

Note: you should only create peering between accounts and networks you trust. There is no limits on what traffic can flow. The server firewall has no effect for private type networks.

It is required that both networks have a Router attached to the network.

post/1.3/network-peering

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/network-peering
  • Auth: HTTP bearer

Request body

configured_status'active' | 'disabled'
namestring required

Example request

{
  "configured_status": "active",
  "name": "Peering A->B",
  "network": {
    "uuid": "03126dc1-a69f-4bc2-8b24-e31c22d64712"
  },
  "peer_network": {
    "uuid": "03585987-bf7d-4544-8e9b-5a1b4d74a333"
  }
}

Response

The network peering was successfully created.

configured_status'active' | 'disabled'
namestring

Name of a network peering relationship.

state'active' | 'pending-peer' | 'provisioning' | 'conflict-subnet' | 'missing-local-router' | 'missing-peer-router' | 'deleted-peer-network' | 'disabled' | 'peer-disabled' | 'error'

Current lifecycle state of a network peering.

uuidstring uuid

Universally unique identifier

created_atstring date-time

Datetime in RFC 3339 format

updated_atstring date-time

Datetime in RFC 3339 format

Example response

{
  "configured_status": "active",
  "name": "Peering A->B",
  "network": {
    "ip_networks": {
      "ip_network": [
        {
          "address": "192.168.0.0/24",
          "family": "IPv4"
        },
        {
          "address": "fc02:c4f3::/64",
          "family": "IPv6"
        }
      ]
    },
    "uuid": "03126dc1-a69f-4bc2-8b24-e31c22d64712"
  },
  "peer_network": {
    "ip_networks": {
      "ip_network": [
        {
          "address": "192.168.99.0/24",
          "family": "IPv4"
        },
        {
          "address": "fc02:c4f3:99::/64",
          "family": "IPv6"
        }
      ]
    },
    "uuid": "03585987-bf7d-4544-8e9b-5a1b4d74a333"
  },
  "state": "active",
  "uuid": "0f7984bc-5d72-4aaf-b587-90e6a8f32efc",
  "created_at": "2026-07-01T00:00:00Z"
}

Changes

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