Network Peering

Download schema

Network peering management

List network peerings

GET

https://api.upcloud.com

/1.3/network-peering

Retrieves a list of network peerings.

List network peerings › query Parameters

uuid

networkPeeringUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f…

Filter by network peering UUID.

Universally unique identifier

network_uuid_local

networkPeeringUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f…

Filter by local network uuid.

Universally unique identifier

network_uuid_peer

networkPeeringUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f…

Filter by peer network uuid.

Universally unique identifier

label

string

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

List network peerings › Responses

A list of network peerings.

Network peerings

networkPeerings

object · required

GET/1.3/network-peering

curl https://api.upcloud.com/1.3/network-peering \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "network_peerings": {
    "network_peering": [
      {
        "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"
      }
    ]
  }
}

json

application/json

Create network peering

POST

https://api.upcloud.com

/1.3/network-peering

Creates a new network peering between two networks.

Create network peering › Request Body

Describes the mutable properties when creating a network-peering between two networks

networkPeeringCreate

name

string · required

object · required

Describes the local side of the peering

object · required

Describes the peer side of the peering

configured_status

string · enum

Enum values:

active

disabled

Default: active

Create network peering › Responses

The network peering was successfully created.

Network peering object describes a peering relationship between two networks

networkPeering

configured_status

string · enum

Enum values:

active

disabled

name

networkPeeringName · minLength: 1 · maxLength: 255

object

Describes the local side of the peering

object

Describes the peer side of the peering

state

networkPeeringState · enum

Enum values:

active

pending-peer

provisioning

conflict-subnet

missing-local-router

missing-peer-router

deleted-peer-network

disabled

uuid

networkPeeringUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f…

Universally unique identifier

POST/1.3/network-peering

curl https://api.upcloud.com/1.3/network-peering \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "configured_status": "active",
  "name": "Peering A->B",
  "network": {
    "uuid": "03126dc1-a69f-4bc2-8b24-e31c22d64712"
  },
  "peer_network": {
    "uuid": "03585987-bf7d-4544-8e9b-5a1b4d74a333"
  }
}'

Example Request Body

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

json

Example Responses

{
  "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"
}

json

application/json

Get network peering

GET

https://api.upcloud.com

/1.3/network-peering/{peering_uuid}

Retrieves information about a specific network peering.

Get network peering › path Parameters

peering_uuid

string · uuid · required

The network peering identifier.

Get network peering › Responses

Details of the specified network peering.

Network peering object describes a peering relationship between two networks

networkPeering

configured_status

string · enum

Enum values:

active

disabled

name

networkPeeringName · minLength: 1 · maxLength: 255

object

Describes the local side of the peering

object

Describes the peer side of the peering

state

networkPeeringState · enum

Enum values:

active

pending-peer

provisioning

conflict-subnet

missing-local-router

missing-peer-router

deleted-peer-network

disabled

uuid

networkPeeringUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f…

Universally unique identifier

GET/1.3/network-peering/{peering_uuid}

curl https://api.upcloud.com/1.3/network-peering/:peering_uuid \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "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"
}

json

application/json

Delete network peering

DELETE

https://api.upcloud.com

/1.3/network-peering/{peering_uuid}

Deletes a specific network peering.

Delete network peering › path Parameters

peering_uuid

string · uuid · required

The network peering identifier.

Delete network peering › Responses

The network peering was successfully deleted.

No data returned

Modify network peering

PATCH

https://api.upcloud.com

/1.3/network-peering/{peering_uuid}

Modifies attributes of an existing network peering.

Modify network peering › path Parameters

peering_uuid

string · uuid · required

The network peering identifier.

Modify network peering › Request Body

Describes the mutable properties when modifying a network-peering

networkPeeringModify

configured_status

enum

Enum values:

active

disabled

name

string

Modify network peering › Responses

The network peering was successfully modified.

Network peering object describes a peering relationship between two networks

networkPeering

configured_status

string · enum

Enum values:

active

disabled

name

networkPeeringName · minLength: 1 · maxLength: 255

object

Describes the local side of the peering

object

Describes the peer side of the peering

state

networkPeeringState · enum

Enum values:

active

pending-peer

provisioning

conflict-subnet

missing-local-router

missing-peer-router

deleted-peer-network

disabled

uuid

networkPeeringUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f…

Universally unique identifier

PATCH/1.3/network-peering/{peering_uuid}

curl https://api.upcloud.com/1.3/network-peering/:peering_uuid \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "configured_status": "disabled",
  "name": "Peering A->B modified"
}'

Example Request Body

{
  "configured_status": "disabled",
  "name": "Peering A->B modified"
}

json

Example Responses

{
  "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"
}

json

application/json

Network IP Address

List network peerings

GET

https://api.upcloud.com

/1.3/network-peering

Retrieves a list of network peerings.

List network peerings › query Parameters

uuid

networkPeeringUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f…

Filter by network peering UUID.

Universally unique identifier

network_uuid_local

networkPeeringUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f…

Filter by local network uuid.

Universally unique identifier

network_uuid_peer

networkPeeringUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f…

Filter by peer network uuid.

Universally unique identifier

label

string

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

List network peerings › Responses

A list of network peerings.

Network peerings

networkPeerings

object · required

Create network peering

POST

https://api.upcloud.com

/1.3/network-peering

Creates a new network peering between two networks.

Create network peering › Request Body

Describes the mutable properties when creating a network-peering between two networks

networkPeeringCreate

name

string · required

object · required

Describes the local side of the peering

object · required

Describes the peer side of the peering

configured_status

string · enum

Enum values:

active

disabled

Default: active

Create network peering › Responses

The network peering was successfully created.

Network peering object describes a peering relationship between two networks

networkPeering

configured_status

string · enum

Enum values:

active

disabled

name

networkPeeringName · minLength: 1 · maxLength: 255

object

Describes the local side of the peering

object

Describes the peer side of the peering

state

networkPeeringState · enum

Enum values:

active

pending-peer

provisioning

conflict-subnet

missing-local-router

missing-peer-router

deleted-peer-network

disabled

uuid

networkPeeringUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f…

Universally unique identifier

Get network peering

GET

https://api.upcloud.com

/1.3/network-peering/{peering_uuid}

Retrieves information about a specific network peering.

Get network peering › path Parameters

peering_uuid

string · uuid · required

The network peering identifier.

Get network peering › Responses

Details of the specified network peering.

Network peering object describes a peering relationship between two networks

networkPeering

configured_status

string · enum

Enum values:

active

disabled

name

networkPeeringName · minLength: 1 · maxLength: 255

object

Describes the local side of the peering

object

Describes the peer side of the peering

state

networkPeeringState · enum

Enum values:

active

pending-peer

provisioning

conflict-subnet

missing-local-router

missing-peer-router

deleted-peer-network

disabled

uuid

networkPeeringUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f…

Universally unique identifier

Delete network peering

DELETE

https://api.upcloud.com

/1.3/network-peering/{peering_uuid}

Deletes a specific network peering.

Delete network peering › path Parameters

peering_uuid

string · uuid · required

The network peering identifier.

Delete network peering › Responses

The network peering was successfully deleted.

No data returned

Modify network peering

PATCH

https://api.upcloud.com

/1.3/network-peering/{peering_uuid}

Modifies attributes of an existing network peering.

Modify network peering › path Parameters

peering_uuid

string · uuid · required

The network peering identifier.

Modify network peering › Request Body

Describes the mutable properties when modifying a network-peering

networkPeeringModify

configured_status

enum

Enum values:

active

disabled

name

string

Modify network peering › Responses

The network peering was successfully modified.

Network peering object describes a peering relationship between two networks

networkPeering

configured_status

string · enum

Enum values:

active

disabled

name

networkPeeringName · minLength: 1 · maxLength: 255

object

Describes the local side of the peering

object

Describes the peer side of the peering

state

networkPeeringState · enum

Enum values:

active

pending-peer

provisioning

conflict-subnet

missing-local-router

missing-peer-router

deleted-peer-network

disabled

uuid

networkPeeringUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f…

Universally unique identifier