Network

Download schema

The network API calls present the different networks attached to cloud servers and allow the configuration of SDN private networks.

Networks define a secure connections between attached cloud servers using a specialised network interface. A cloud server may belong to any number of virtual networks at the same time. Server interfaces are identified and ordered by their index.

Network types

Public networks

Public networks provide internet connectivity to the cloud servers. Public networks are automatically added as public IP addresses are attached to cloud servers.

Utility network

The Utility network is a simple to use, yet functionally limited network connecting all cloud servers under the same UpCloud account. All cloud servers are connected to the Utility network by default. This way the Utility network forms a secure connection between all servers within one account, no matter where they are located. IP addressing on the Utility network is specified automatically and cannot be changed. The Utility network is limited to one connection per cloud server. SDN private networks are to be used for production workloads and any advanced network setups. The Utility network is added by adding a utility IP address.

Private virtual LAN

SDN private networks provide flexible and customisable network configuration options beyond that of the Utility network and are recommended for production workloads.

These networks provide secure connections between attached cloud servers using dedicated network interfaces. Servers can be attached and detached from SDN private networks at will using the API commands. SDN private networks allow a practically unlimited number of cloud servers to be attached simultaneously and a cloud server may belong to any number of SDN private networks at the same time. IP addressing may be defined automatically or custom IP addressing may be used. SDN private networks are configured per zone allowing cloud server on the same zone to be attached.

Available IP subnets in Private virtual LANs

Generally, you can use any global unicast address for your subnet address, even public ones. However, we recommend staying with well-known private address ranges.

Private address ranges include: 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16.

Allowed subnet prefix lengths (sizes): minimum length 8 bits, maximum length 29 bits.

Excluded ranges:

100.64.0.0/10 (CGNAT)
127.0.0.0/8 (localhost)
224.0.0.0/4 (IP multicast)
169.254.0.0/16 (link local)

The above ranges are not available for use in Private virtual LANs.

For more information on:

adding network interfaces to cloud servers see.
modifying network interfaces from cloud servers see.
deleting network interfaces from cloud servers see.
assigning IP addresses to cloud servers see.
deleting addresses from cloud servers see.

List networks

GET

https://api.upcloud.com

/1.3/network

Get a list of all networks.

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

List networks › query Parameters

networkLabel

Filter networks by labels.

A key/value pair to label and categorize resources

List networks › Responses

List of networks.

Response schema containing a list of networks.

networks

object · required

Container object for network items.

Create SDN network

POST

https://api.upcloud.com

/1.3/network

Creates a new SDN private network that cloud servers from the same zone can be attached to.

Create SDN network › Request Body

Request schema for creating a network

createNetworkRequest

object · required

Create SDN network › Responses

Created network.

Response schema containing a single network.

network

networkDetails · required

Detailed network resource attributes.

POST/1.3/network

curl https://api.upcloud.com/1.3/network \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "network": {
    "type": "private",
    "name": "backend-net",
    "zone": "fi-hel2",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "10.0.0.0/24",
          "dhcp": "yes"
        }
      ]
    }
  }
}'

Example Request Body

{
  "network": {
    "type": "private",
    "name": "backend-net",
    "zone": "fi-hel2",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "10.0.0.0/24",
          "dhcp": "yes"
        }
      ]
    }
  }
}

json

Example Responses

{
  "network": {
    "evi": 1234,
    "grt_export": "no",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "192.168.150.0/24",
          "dhcp": "yes",
          "dhcp_dns": [
            "192.168.150.1",
            "192.168.150.254"
          ],
          "gateway": "192.168.150.1"
        }
      ]
    },
    "name": "Example network",
    "network_features": [
      "allow-linklocal-address",
      "allow-overlapping-ip-network",
      "managed-by-service"
    ],
    "parent_network": "037b0e4b-2734-4d5d-89ba-1737fc4593bf",
    "peerings": {
      "peering": [
        {
          "name": "Peering A->B",
          "state": "pending-peer",
          "uuid": "0fc82c18-1e5e-4076-afcd-3b85869800e7"
        }
      ]
    },
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "services": {
      "service": [
        {
          "name": "OBJECT-STORAGE",
          "service_routes": [
            "10.10.10.0/24"
          ]
        }
      ]
    },
    "type": "private",
    "uuid": "039a8811-e279-46c2-8e45-1962767f5a4c",
    "zone": "fi-hel1"
  }
}

json

application/json

List interfaces

GET

https://api.upcloud.com

/1.3/network/interface

Retrieves a list of network interfaces.

List interfaces › Responses

List of network interfaces.

Response schema for listing network interfaces

networkInterfaces

object · required

Create interface

POST

https://api.upcloud.com

/1.3/network/interface

Creates a new network interface.

Create interface › Request Body

Request schema for creating a network interface

networkCreateInterfaceRequest

main_account_id

networkAccountId · int64 · min: 1

Unique numeric identifier of an account.

object

Create interface › Responses

Created network interface.

Response schema for listing network interfaces

networkInterface

bootable

networkBooleanYesno · enum · required

Boolean value represented as yes/no

Enum values:

yes

object[] · required

mac

string · required

network

string · required

source_ip_filtering

networkBooleanYesno · enum · required

Boolean value represented as yes/no

Enum values:

yes

type

networkType · enum · required

Network access type

Enum values:

public

utility

private

uuid

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

Universally unique identifier

server

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

Universally unique identifier

POST/1.3/network/interface

curl https://api.upcloud.com/1.3/network/interface \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "main_account_id": 123456,
  "interface": {
    "type": "private",
    "network": "8f6d1ec2-8f5e-4b67-8fcb-6fa9c1a8a001",
    "source_ip_filtering": "yes",
    "bootable": "no"
  }
}'

Example Request Body

{
  "main_account_id": 123456,
  "interface": {
    "type": "private",
    "network": "8f6d1ec2-8f5e-4b67-8fcb-6fa9c1a8a001",
    "source_ip_filtering": "yes",
    "bootable": "no"
  }
}

json

Example Responses

{
  "uuid": "8f6d1ec2-8f5e-4b67-8fcb-6fa9c1a8a003",
  "type": "private",
  "network": "8f6d1ec2-8f5e-4b67-8fcb-6fa9c1a8a001",
  "mac": "00:16:3e:12:34:56",
  "source_ip_filtering": "yes",
  "bootable": "no",
  "ip_addresses": [
    {
      "ip_address": {
        "address": "10.0.0.10",
        "family": "IPv4",
        "floating": "no",
        "release_policy": "keep",
        "dhcp_provided": "yes"
      }
    }
  ]
}

json

application/json

Get interface

GET

https://api.upcloud.com

/1.3/network/interface/{uuid}

Retrieves details of a specific network interface.

Get interface › path Parameters

uuid

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

UUID of the network interface.

Universally unique identifier

Get interface › Responses

Details of the requested network interface.

Response schema containing a single network.

network

networkDetails · required

Detailed network resource attributes.

GET/1.3/network/interface/{uuid}

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

Example Responses

{
  "network": {
    "evi": 1234,
    "grt_export": "no",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "192.168.150.0/24",
          "dhcp": "yes",
          "dhcp_dns": [
            "192.168.150.1",
            "192.168.150.254"
          ],
          "gateway": "192.168.150.1"
        }
      ]
    },
    "name": "Example network",
    "network_features": [
      "allow-linklocal-address",
      "allow-overlapping-ip-network",
      "managed-by-service"
    ],
    "parent_network": "037b0e4b-2734-4d5d-89ba-1737fc4593bf",
    "peerings": {
      "peering": [
        {
          "name": "Peering A->B",
          "state": "pending-peer",
          "uuid": "0fc82c18-1e5e-4076-afcd-3b85869800e7"
        }
      ]
    },
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "services": {
      "service": [
        {
          "name": "OBJECT-STORAGE",
          "service_routes": [
            "10.10.10.0/24"
          ]
        }
      ]
    },
    "type": "private",
    "uuid": "039a8811-e279-46c2-8e45-1962767f5a4c",
    "zone": "fi-hel1"
  }
}

json

application/json

Delete interface

DELETE

https://api.upcloud.com

/1.3/network/interface/{uuid}

Deletes a specific network interface.

Delete interface › path Parameters

uuid

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

UUID of the network.

Universally unique identifier

Delete interface › Responses

Network interface successfully deleted.

No data returned

Get network

GET

https://api.upcloud.com

/1.3/network/{uuid}

Retrieves details of a specific network.

Get network › path Parameters

uuid

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

UUID of the network.

Universally unique identifier

Get network › Responses

Details of the requested network.

Response schema containing a single network.

network

networkDetails · required

Detailed network resource attributes.

GET/1.3/network/{uuid}

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

Example Responses

{
  "network": {
    "evi": 1234,
    "grt_export": "no",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "192.168.150.0/24",
          "dhcp": "yes",
          "dhcp_dns": [
            "192.168.150.1",
            "192.168.150.254"
          ],
          "gateway": "192.168.150.1"
        }
      ]
    },
    "name": "Example network",
    "network_features": [
      "allow-linklocal-address",
      "allow-overlapping-ip-network",
      "managed-by-service"
    ],
    "parent_network": "037b0e4b-2734-4d5d-89ba-1737fc4593bf",
    "peerings": {
      "peering": [
        {
          "name": "Peering A->B",
          "state": "pending-peer",
          "uuid": "0fc82c18-1e5e-4076-afcd-3b85869800e7"
        }
      ]
    },
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "services": {
      "service": [
        {
          "name": "OBJECT-STORAGE",
          "service_routes": [
            "10.10.10.0/24"
          ]
        }
      ]
    },
    "type": "private",
    "uuid": "039a8811-e279-46c2-8e45-1962767f5a4c",
    "zone": "fi-hel1"
  }
}

json

application/json

Modify network

PUT

https://api.upcloud.com

/1.3/network/{uuid}

Modifies the details of a specific SDN private network. The Utility and public networks cannot be modified.

Modify network › path Parameters

uuid

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

UUID of the network.

Universally unique identifier

Modify network › Request Body

Request schema for modifying a network

modifyNetworkRequest

object · required

Modify network › Responses

Updated network details.

Response schema containing a single network.

network

networkDetails · required

Detailed network resource attributes.

PUT/1.3/network/{uuid}

curl https://api.upcloud.com/1.3/network/:uuid \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "network": {
    "type": "public",
    "name": "name",
    "zone": "fi-hel1",
    "tags": {
      "tags": {
        "tag": [
          {
            "name": "PROD",
            "description": "Production servers",
            "servers": {
              "server": [
                "0077fa3d-32db-4b09-9f5f-30d9e9afb565"
              ]
            }
          }
        ]
      }
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "prod"
        },
        {
          "key": "team",
          "value": "network"
        }
      ]
    },
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "grt_export": 0,
    "parent_network": "parent_network",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "address",
          "gateway": "10.0.0.20",
          "dhcp": "dhcp",
          "dhcp_default_route": "dhcp_default_route",
          "dhcp_dns": [
            "10.0.0.20"
          ],
          "dhcp_routes": [
            "string"
          ],
          "dhcp_bootfile_url": "dhcp_bootfile_url"
        }
      ]
    },
    "network_features": "allow-linklocal-address",
    "main_account_id": 1
  }
}'

Example Request Body

{
  "network": {
    "type": "public",
    "name": "name",
    "zone": "fi-hel1",
    "tags": {
      "tags": {
        "tag": [
          {
            "name": "PROD",
            "description": "Production servers",
            "servers": {
              "server": [
                "0077fa3d-32db-4b09-9f5f-30d9e9afb565"
              ]
            }
          }
        ]
      }
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "prod"
        },
        {
          "key": "team",
          "value": "network"
        }
      ]
    },
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "grt_export": 0,
    "parent_network": "parent_network",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "address",
          "gateway": "10.0.0.20",
          "dhcp": "dhcp",
          "dhcp_default_route": "dhcp_default_route",
          "dhcp_dns": [
            "10.0.0.20"
          ],
          "dhcp_routes": [
            "string"
          ],
          "dhcp_bootfile_url": "dhcp_bootfile_url"
        }
      ]
    },
    "network_features": "allow-linklocal-address",
    "main_account_id": 1
  }
}

json

Example Responses

{
  "network": {
    "evi": 1234,
    "grt_export": "no",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "192.168.150.0/24",
          "dhcp": "yes",
          "dhcp_dns": [
            "192.168.150.1",
            "192.168.150.254"
          ],
          "gateway": "192.168.150.1"
        }
      ]
    },
    "name": "Example network",
    "network_features": [
      "allow-linklocal-address",
      "allow-overlapping-ip-network",
      "managed-by-service"
    ],
    "parent_network": "037b0e4b-2734-4d5d-89ba-1737fc4593bf",
    "peerings": {
      "peering": [
        {
          "name": "Peering A->B",
          "state": "pending-peer",
          "uuid": "0fc82c18-1e5e-4076-afcd-3b85869800e7"
        }
      ]
    },
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "services": {
      "service": [
        {
          "name": "OBJECT-STORAGE",
          "service_routes": [
            "10.10.10.0/24"
          ]
        }
      ]
    },
    "type": "private",
    "uuid": "039a8811-e279-46c2-8e45-1962767f5a4c",
    "zone": "fi-hel1"
  }
}

json

application/json

Delete network

DELETE

https://api.upcloud.com

/1.3/network/{uuid}

Deletes an SDN private network. All attached cloud servers must first be detached before SDN private networks can be deleted. Utility and public networks can only be detached from servers by Releasing the corresponding IP addresses.

Delete network › path Parameters

uuid

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

UUID of the network.

Universally unique identifier

Delete network › Responses

Network successfully deleted.

No data returned

VNC Keymap Network Peering

UpCloud API

Network

Download schema

The network API calls present the different networks attached to cloud servers and allow the configuration of SDN private networks.

Network types

Public networks

Public networks provide internet connectivity to the cloud servers. Public networks are automatically added as public IP addresses are attached to cloud servers.

Utility network

Private virtual LAN

SDN private networks provide flexible and customisable network configuration options beyond that of the Utility network and are recommended for production workloads.

Available IP subnets in Private virtual LANs

Generally, you can use any global unicast address for your subnet address, even public ones. However, we recommend staying with well-known private address ranges.

Private address ranges include: 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16.

Allowed subnet prefix lengths (sizes): minimum length 8 bits, maximum length 29 bits.

Excluded ranges:

100.64.0.0/10 (CGNAT)
127.0.0.0/8 (localhost)
224.0.0.0/4 (IP multicast)
169.254.0.0/16 (link local)

The above ranges are not available for use in Private virtual LANs.

For more information on:

adding network interfaces to cloud servers see.
modifying network interfaces from cloud servers see.
deleting network interfaces from cloud servers see.
assigning IP addresses to cloud servers see.
deleting addresses from cloud servers see.

List networks

GET

https://api.upcloud.com

/1.3/network

Get a list of all networks.

List networks › query Parameters

networkLabel

Filter networks by labels.

A key/value pair to label and categorize resources

List networks › Responses

List of networks.

Response schema containing a list of networks.

networks

object · required

Container object for network items.

Create SDN network

POST

https://api.upcloud.com

/1.3/network

Creates a new SDN private network that cloud servers from the same zone can be attached to.

Create SDN network › Request Body

Request schema for creating a network

createNetworkRequest

object · required

Create SDN network › Responses

Created network.

Response schema containing a single network.

network

networkDetails · required

Detailed network resource attributes.

POST/1.3/network

curl https://api.upcloud.com/1.3/network \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "network": {
    "type": "private",
    "name": "backend-net",
    "zone": "fi-hel2",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "10.0.0.0/24",
          "dhcp": "yes"
        }
      ]
    }
  }
}'

Example Request Body

{
  "network": {
    "type": "private",
    "name": "backend-net",
    "zone": "fi-hel2",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "10.0.0.0/24",
          "dhcp": "yes"
        }
      ]
    }
  }
}

json

Example Responses

{
  "network": {
    "evi": 1234,
    "grt_export": "no",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "192.168.150.0/24",
          "dhcp": "yes",
          "dhcp_dns": [
            "192.168.150.1",
            "192.168.150.254"
          ],
          "gateway": "192.168.150.1"
        }
      ]
    },
    "name": "Example network",
    "network_features": [
      "allow-linklocal-address",
      "allow-overlapping-ip-network",
      "managed-by-service"
    ],
    "parent_network": "037b0e4b-2734-4d5d-89ba-1737fc4593bf",
    "peerings": {
      "peering": [
        {
          "name": "Peering A->B",
          "state": "pending-peer",
          "uuid": "0fc82c18-1e5e-4076-afcd-3b85869800e7"
        }
      ]
    },
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "services": {
      "service": [
        {
          "name": "OBJECT-STORAGE",
          "service_routes": [
            "10.10.10.0/24"
          ]
        }
      ]
    },
    "type": "private",
    "uuid": "039a8811-e279-46c2-8e45-1962767f5a4c",
    "zone": "fi-hel1"
  }
}

json

application/json

List interfaces

GET

https://api.upcloud.com

/1.3/network/interface

Retrieves a list of network interfaces.

List interfaces › Responses

List of network interfaces.

Response schema for listing network interfaces

networkInterfaces

object · required

Create interface

POST

https://api.upcloud.com

/1.3/network/interface

Creates a new network interface.

Create interface › Request Body

Request schema for creating a network interface

networkCreateInterfaceRequest

main_account_id

networkAccountId · int64 · min: 1

Unique numeric identifier of an account.

object

Create interface › Responses

Created network interface.

Response schema for listing network interfaces

networkInterface

bootable

networkBooleanYesno · enum · required

Boolean value represented as yes/no

Enum values:

yes

object[] · required

mac

string · required

network

string · required

source_ip_filtering

networkBooleanYesno · enum · required

Boolean value represented as yes/no

Enum values:

yes

type

networkType · enum · required

Network access type

Enum values:

public

utility

private

uuid

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

Universally unique identifier

server

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

Universally unique identifier

POST/1.3/network/interface

curl https://api.upcloud.com/1.3/network/interface \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "main_account_id": 123456,
  "interface": {
    "type": "private",
    "network": "8f6d1ec2-8f5e-4b67-8fcb-6fa9c1a8a001",
    "source_ip_filtering": "yes",
    "bootable": "no"
  }
}'

Example Request Body

{
  "main_account_id": 123456,
  "interface": {
    "type": "private",
    "network": "8f6d1ec2-8f5e-4b67-8fcb-6fa9c1a8a001",
    "source_ip_filtering": "yes",
    "bootable": "no"
  }
}

json

Example Responses

{
  "uuid": "8f6d1ec2-8f5e-4b67-8fcb-6fa9c1a8a003",
  "type": "private",
  "network": "8f6d1ec2-8f5e-4b67-8fcb-6fa9c1a8a001",
  "mac": "00:16:3e:12:34:56",
  "source_ip_filtering": "yes",
  "bootable": "no",
  "ip_addresses": [
    {
      "ip_address": {
        "address": "10.0.0.10",
        "family": "IPv4",
        "floating": "no",
        "release_policy": "keep",
        "dhcp_provided": "yes"
      }
    }
  ]
}

json

application/json

Get interface

GET

https://api.upcloud.com

/1.3/network/interface/{uuid}

Retrieves details of a specific network interface.

Get interface › path Parameters

uuid

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

UUID of the network interface.

Universally unique identifier

Get interface › Responses

Details of the requested network interface.

Response schema containing a single network.

network

networkDetails · required

Detailed network resource attributes.

GET/1.3/network/interface/{uuid}

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

Example Responses

{
  "network": {
    "evi": 1234,
    "grt_export": "no",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "192.168.150.0/24",
          "dhcp": "yes",
          "dhcp_dns": [
            "192.168.150.1",
            "192.168.150.254"
          ],
          "gateway": "192.168.150.1"
        }
      ]
    },
    "name": "Example network",
    "network_features": [
      "allow-linklocal-address",
      "allow-overlapping-ip-network",
      "managed-by-service"
    ],
    "parent_network": "037b0e4b-2734-4d5d-89ba-1737fc4593bf",
    "peerings": {
      "peering": [
        {
          "name": "Peering A->B",
          "state": "pending-peer",
          "uuid": "0fc82c18-1e5e-4076-afcd-3b85869800e7"
        }
      ]
    },
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "services": {
      "service": [
        {
          "name": "OBJECT-STORAGE",
          "service_routes": [
            "10.10.10.0/24"
          ]
        }
      ]
    },
    "type": "private",
    "uuid": "039a8811-e279-46c2-8e45-1962767f5a4c",
    "zone": "fi-hel1"
  }
}

json

application/json

Delete interface

DELETE

https://api.upcloud.com

/1.3/network/interface/{uuid}

Deletes a specific network interface.

Delete interface › path Parameters

uuid

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

UUID of the network.

Universally unique identifier

Delete interface › Responses

Network interface successfully deleted.

No data returned

Get network

GET

https://api.upcloud.com

/1.3/network/{uuid}

Retrieves details of a specific network.

Get network › path Parameters

uuid

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

UUID of the network.

Universally unique identifier

Get network › Responses

Details of the requested network.

Response schema containing a single network.

network

networkDetails · required

Detailed network resource attributes.

GET/1.3/network/{uuid}

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

Example Responses

{
  "network": {
    "evi": 1234,
    "grt_export": "no",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "192.168.150.0/24",
          "dhcp": "yes",
          "dhcp_dns": [
            "192.168.150.1",
            "192.168.150.254"
          ],
          "gateway": "192.168.150.1"
        }
      ]
    },
    "name": "Example network",
    "network_features": [
      "allow-linklocal-address",
      "allow-overlapping-ip-network",
      "managed-by-service"
    ],
    "parent_network": "037b0e4b-2734-4d5d-89ba-1737fc4593bf",
    "peerings": {
      "peering": [
        {
          "name": "Peering A->B",
          "state": "pending-peer",
          "uuid": "0fc82c18-1e5e-4076-afcd-3b85869800e7"
        }
      ]
    },
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "services": {
      "service": [
        {
          "name": "OBJECT-STORAGE",
          "service_routes": [
            "10.10.10.0/24"
          ]
        }
      ]
    },
    "type": "private",
    "uuid": "039a8811-e279-46c2-8e45-1962767f5a4c",
    "zone": "fi-hel1"
  }
}

json

application/json

Modify network

PUT

https://api.upcloud.com

/1.3/network/{uuid}

Modifies the details of a specific SDN private network. The Utility and public networks cannot be modified.

Modify network › path Parameters

uuid

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

UUID of the network.

Universally unique identifier

Modify network › Request Body

Request schema for modifying a network

modifyNetworkRequest

object · required

Modify network › Responses

Updated network details.

Response schema containing a single network.

network

networkDetails · required

Detailed network resource attributes.

PUT/1.3/network/{uuid}

curl https://api.upcloud.com/1.3/network/:uuid \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "network": {
    "type": "public",
    "name": "name",
    "zone": "fi-hel1",
    "tags": {
      "tags": {
        "tag": [
          {
            "name": "PROD",
            "description": "Production servers",
            "servers": {
              "server": [
                "0077fa3d-32db-4b09-9f5f-30d9e9afb565"
              ]
            }
          }
        ]
      }
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "prod"
        },
        {
          "key": "team",
          "value": "network"
        }
      ]
    },
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "grt_export": 0,
    "parent_network": "parent_network",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "address",
          "gateway": "10.0.0.20",
          "dhcp": "dhcp",
          "dhcp_default_route": "dhcp_default_route",
          "dhcp_dns": [
            "10.0.0.20"
          ],
          "dhcp_routes": [
            "string"
          ],
          "dhcp_bootfile_url": "dhcp_bootfile_url"
        }
      ]
    },
    "network_features": "allow-linklocal-address",
    "main_account_id": 1
  }
}'

Example Request Body

{
  "network": {
    "type": "public",
    "name": "name",
    "zone": "fi-hel1",
    "tags": {
      "tags": {
        "tag": [
          {
            "name": "PROD",
            "description": "Production servers",
            "servers": {
              "server": [
                "0077fa3d-32db-4b09-9f5f-30d9e9afb565"
              ]
            }
          }
        ]
      }
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "prod"
        },
        {
          "key": "team",
          "value": "network"
        }
      ]
    },
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "grt_export": 0,
    "parent_network": "parent_network",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "address",
          "gateway": "10.0.0.20",
          "dhcp": "dhcp",
          "dhcp_default_route": "dhcp_default_route",
          "dhcp_dns": [
            "10.0.0.20"
          ],
          "dhcp_routes": [
            "string"
          ],
          "dhcp_bootfile_url": "dhcp_bootfile_url"
        }
      ]
    },
    "network_features": "allow-linklocal-address",
    "main_account_id": 1
  }
}

json

Example Responses

{
  "network": {
    "evi": 1234,
    "grt_export": "no",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "192.168.150.0/24",
          "dhcp": "yes",
          "dhcp_dns": [
            "192.168.150.1",
            "192.168.150.254"
          ],
          "gateway": "192.168.150.1"
        }
      ]
    },
    "name": "Example network",
    "network_features": [
      "allow-linklocal-address",
      "allow-overlapping-ip-network",
      "managed-by-service"
    ],
    "parent_network": "037b0e4b-2734-4d5d-89ba-1737fc4593bf",
    "peerings": {
      "peering": [
        {
          "name": "Peering A->B",
          "state": "pending-peer",
          "uuid": "0fc82c18-1e5e-4076-afcd-3b85869800e7"
        }
      ]
    },
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "services": {
      "service": [
        {
          "name": "OBJECT-STORAGE",
          "service_routes": [
            "10.10.10.0/24"
          ]
        }
      ]
    },
    "type": "private",
    "uuid": "039a8811-e279-46c2-8e45-1962767f5a4c",
    "zone": "fi-hel1"
  }
}

json

application/json

Delete network

DELETE

https://api.upcloud.com

/1.3/network/{uuid}

Delete network › path Parameters

uuid

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

UUID of the network.

Universally unique identifier

Delete network › Responses

Network successfully deleted.

No data returned

VNC Keymap Network Peering