List peerings

Get a list of all peerings within the current account. Only peerings that refer to a network that the current account has access are returned.

It is also possible to filter network peering with label URL parameters, e.g. ?label=env or ?label=env%3Dprod. The URL parameter can be given multiple times to add more filters (e.g. ?label=env%3Dprod&label=v2), where only network peering that match all labels are returned. Label keys are matched case insensitively.

get/1.3/network-peering

Request

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

Query parameters

uuidstring uuid

Universally unique identifier

Example:0414e0d7-4436-4037-9dd8-6eaf47dce599

Filter by network peering UUID.

network_uuid_localstring uuid

Universally unique identifier

Example:0414e0d7-4436-4037-9dd8-6eaf47dce599

Filter by local network uuid.

network_uuid_peerstring uuid

Universally unique identifier

Example:0414e0d7-4436-4037-9dd8-6eaf47dce599

Filter by peer network uuid.

labelstring

Label filter in the form key=value. Can be specified multiple times to filter by multiple labels.

Response

A list of network peerings.

Example response

{
  "network_peerings": {
    "network_peering": [
      {
        "configured_status": "active",
        "name": "Peering A->B",
        "network": {
          "uuid": "03126dc1-a69f-4bc2-8b24-e31c22d64712"
        },
        "peer_network": {
          "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.