network-peering

Get peering

Returns the state of an existing network peering.

Note that the peer_network field only contains the network details if the peering has been defined by both accounts.

get/1.3/network-peering/{peering_uuid}

Request

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

Path parameters

peering_uuidstring uuid required

The network peering identifier.

Response

Details of the specified network peering.

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.