Network

Download schema

Manages virtual networks and network interfaces.

List networks

GET

https://api.upcloud.com

/1.3/network

Retrieves a list of 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.

networks

object · required

required

additionalProperties

GET/1.3/network

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

Example Responses

{
  "networks": {
    "network": [
      {
        "evi": "1234",
        "grt_export": "no",
        "ip_networks": {
          "ip_network": [
            {
              "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"
      }
    ]
  },
  "required": {},
  "additionalProperties": {}
}

json

application/json

Create an SDN private 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 an SDN private network › Request Body

Request schema for creating a network

createNetworkRequest

object · required

Create an SDN private network › Responses

network

networkDetails · required

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": "public",
    "name": "name",
    "zone": "fi-hel1",
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "address",
          "gateway": "string",
          "dhcp": "yes",
          "dhcp_default_route": "yes",
          "dhcp_dns": [
            "string"
          ],
          "dhcp_routes": [
            "string"
          ],
          "dhcp_bootfile_url": "dhcp_bootfile_url",
          "dhcp_routes_configuration": {
            "effective_routes_auto_population": {
              "enabled": "yes",
              "exclude_by_source": [
                "string"
              ],
              "filter_by_destination": [
                "string"
              ],
              "filter_by_route_type": [
                "string"
              ]
            }
          }
        }
      ]
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    }
  }
}'

Example Request Body

{
  "network": {
    "type": "public",
    "name": "name",
    "zone": "fi-hel1",
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "address",
          "gateway": "string",
          "dhcp": "yes",
          "dhcp_default_route": "yes",
          "dhcp_dns": [
            "string"
          ],
          "dhcp_routes": [
            "string"
          ],
          "dhcp_bootfile_url": "dhcp_bootfile_url",
          "dhcp_routes_configuration": {
            "effective_routes_auto_population": {
              "enabled": "yes",
              "exclude_by_source": [
                "string"
              ],
              "filter_by_destination": [
                "string"
              ],
              "filter_by_route_type": [
                "string"
              ]
            }
          }
        }
      ]
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    }
  }
}

json

Example Responses

{
  "network": {
    "evi": "1234",
    "grt_export": "no",
    "ip_networks": {
      "ip_network": [
        {
          "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 network interfaces

GET

https://api.upcloud.com

/1.3/network/interface

Retrieves a list of network interfaces.

List network interfaces › Responses

Response schema for listing network interfaces

networkInterfaces

interfaces

required

type

required

Create a network interface

POST

https://api.upcloud.com

/1.3/network/interface

Creates a new network interface.

Create a network interface › Request Body

Request schema for creating a network interface

networkCreateInterfaceRequest

main_account_id

networkAccountId · min: 1

object

Create a network interface › Responses

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

Get network interface details

GET

https://api.upcloud.com

/1.3/network/interface/{uuid}

Retrieves details of a specific network interface.

Get network interface details › path Parameters

uuid

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

Universally unique identifier

Get network interface details › Responses

network

networkDetails · required

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": [
        {
          "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 a network interface

DELETE

https://api.upcloud.com

/1.3/network/interface/{uuid}

Deletes a specific network interface.

Delete a network interface › path Parameters

uuid

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

Universally unique identifier

Delete a network interface › Responses

Network interface successfully deleted.

No data returned

Get network details

GET

https://api.upcloud.com

/1.3/network/{uuid}

Retrieves details of a specific network.

Get network details › path Parameters

uuid

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

Universally unique identifier

Get network details › Responses

network

networkDetails · required

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": [
        {
          "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 a network

PUT

https://api.upcloud.com

/1.3/network/{uuid}

Modifies attributes of a specific network.

Modify a network › path Parameters

uuid

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

Universally unique identifier

Modify a network › Request Body

Request schema for modifying a network

modifyNetworkRequest

object · required

Modify a network › Responses

network

networkDetails · required

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": [
          {
            "description": "Development servers",
            "name": "DEV",
            "servers": {
              "server": [
                "0077fa3d-32db-4b09-9f5f-30d9e9afb565"
              ]
            }
          }
        ]
      }
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    },
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "grt_export": 0,
    "parent_network": "parent_network",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "address",
          "gateway": "string",
          "dhcp": "dhcp",
          "dhcp_default_route": "dhcp_default_route",
          "dhcp_dns": [
            "string"
          ],
          "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": [
          {
            "description": "Development servers",
            "name": "DEV",
            "servers": {
              "server": [
                "0077fa3d-32db-4b09-9f5f-30d9e9afb565"
              ]
            }
          }
        ]
      }
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    },
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "grt_export": 0,
    "parent_network": "parent_network",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "address",
          "gateway": "string",
          "dhcp": "dhcp",
          "dhcp_default_route": "dhcp_default_route",
          "dhcp_dns": [
            "string"
          ],
          "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": [
        {
          "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 a network

DELETE

https://api.upcloud.com

/1.3/network/{uuid}

Deletes a specific network.

Delete a network › path Parameters

uuid

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

Universally unique identifier

Delete a network › Responses

Network successfully deleted.

No data returned

VNC Keymap Network Peering

UpCloud API

Network

Download schema

Manages virtual networks and network interfaces.

List networks

GET

https://api.upcloud.com

/1.3/network

Retrieves a list of 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.

networks

object · required

required

additionalProperties

GET/1.3/network

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

Example Responses

{
  "networks": {
    "network": [
      {
        "evi": "1234",
        "grt_export": "no",
        "ip_networks": {
          "ip_network": [
            {
              "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"
      }
    ]
  },
  "required": {},
  "additionalProperties": {}
}

json

application/json

Create an SDN private 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 an SDN private network › Request Body

Request schema for creating a network

createNetworkRequest

object · required

Create an SDN private network › Responses

network

networkDetails · required

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": "public",
    "name": "name",
    "zone": "fi-hel1",
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "address",
          "gateway": "string",
          "dhcp": "yes",
          "dhcp_default_route": "yes",
          "dhcp_dns": [
            "string"
          ],
          "dhcp_routes": [
            "string"
          ],
          "dhcp_bootfile_url": "dhcp_bootfile_url",
          "dhcp_routes_configuration": {
            "effective_routes_auto_population": {
              "enabled": "yes",
              "exclude_by_source": [
                "string"
              ],
              "filter_by_destination": [
                "string"
              ],
              "filter_by_route_type": [
                "string"
              ]
            }
          }
        }
      ]
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    }
  }
}'

Example Request Body

{
  "network": {
    "type": "public",
    "name": "name",
    "zone": "fi-hel1",
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "address",
          "gateway": "string",
          "dhcp": "yes",
          "dhcp_default_route": "yes",
          "dhcp_dns": [
            "string"
          ],
          "dhcp_routes": [
            "string"
          ],
          "dhcp_bootfile_url": "dhcp_bootfile_url",
          "dhcp_routes_configuration": {
            "effective_routes_auto_population": {
              "enabled": "yes",
              "exclude_by_source": [
                "string"
              ],
              "filter_by_destination": [
                "string"
              ],
              "filter_by_route_type": [
                "string"
              ]
            }
          }
        }
      ]
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    }
  }
}

json

Example Responses

{
  "network": {
    "evi": "1234",
    "grt_export": "no",
    "ip_networks": {
      "ip_network": [
        {
          "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 network interfaces

GET

https://api.upcloud.com

/1.3/network/interface

Retrieves a list of network interfaces.

List network interfaces › Responses

Response schema for listing network interfaces

networkInterfaces

interfaces

required

type

required

Create a network interface

POST

https://api.upcloud.com

/1.3/network/interface

Creates a new network interface.

Create a network interface › Request Body

Request schema for creating a network interface

networkCreateInterfaceRequest

main_account_id

networkAccountId · min: 1

object

Create a network interface › Responses

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

Get network interface details

GET

https://api.upcloud.com

/1.3/network/interface/{uuid}

Retrieves details of a specific network interface.

Get network interface details › path Parameters

uuid

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

Universally unique identifier

Get network interface details › Responses

network

networkDetails · required

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": [
        {
          "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 a network interface

DELETE

https://api.upcloud.com

/1.3/network/interface/{uuid}

Deletes a specific network interface.

Delete a network interface › path Parameters

uuid

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

Universally unique identifier

Delete a network interface › Responses

Network interface successfully deleted.

No data returned

Get network details

GET

https://api.upcloud.com

/1.3/network/{uuid}

Retrieves details of a specific network.

Get network details › path Parameters

uuid

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

Universally unique identifier

Get network details › Responses

network

networkDetails · required

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": [
        {
          "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 a network

PUT

https://api.upcloud.com

/1.3/network/{uuid}

Modifies attributes of a specific network.

Modify a network › path Parameters

uuid

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

Universally unique identifier

Modify a network › Request Body

Request schema for modifying a network

modifyNetworkRequest

object · required

Modify a network › Responses

network

networkDetails · required

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": [
          {
            "description": "Development servers",
            "name": "DEV",
            "servers": {
              "server": [
                "0077fa3d-32db-4b09-9f5f-30d9e9afb565"
              ]
            }
          }
        ]
      }
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    },
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "grt_export": 0,
    "parent_network": "parent_network",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "address",
          "gateway": "string",
          "dhcp": "dhcp",
          "dhcp_default_route": "dhcp_default_route",
          "dhcp_dns": [
            "string"
          ],
          "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": [
          {
            "description": "Development servers",
            "name": "DEV",
            "servers": {
              "server": [
                "0077fa3d-32db-4b09-9f5f-30d9e9afb565"
              ]
            }
          }
        ]
      }
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    },
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "grt_export": 0,
    "parent_network": "parent_network",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "address",
          "gateway": "string",
          "dhcp": "dhcp",
          "dhcp_default_route": "dhcp_default_route",
          "dhcp_dns": [
            "string"
          ],
          "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": [
        {
          "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 a network

DELETE

https://api.upcloud.com

/1.3/network/{uuid}

Deletes a specific network.

Delete a network › path Parameters

uuid

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

Universally unique identifier

Delete a network › Responses

Network successfully deleted.

No data returned

VNC Keymap Network Peering