UpCloud Network API

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](https://upcloudltd.github.io/upcloud-openapi-spec/api/ip-address) 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](https://upcloudltd.github.io/upcloud-openapi-spec/api/ip-address#assign-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](https://upcloudltd.github.io/upcloud-openapi-spec/api/server#add-a-network-interface). * modifying network interfaces from cloud servers [see](https://upcloudltd.github.io/upcloud-openapi-spec/api/server#modify-a-network-interface). * deleting network interfaces from cloud servers [see](https://upcloudltd.github.io/upcloud-openapi-spec/api/server#delete-a-network-interface-2). * assigning IP addresses to cloud servers [see](https://upcloudltd.github.io/upcloud-openapi-spec/api/server#add-an-ip-address-to-a-network-interface). * deleting addresses from cloud servers [see](https://upcloudltd.github.io/upcloud-openapi-spec/api/server#delete-an-ip-address-from-a-network-interface).

Business capability
IT Infrastructure Management BC-600.50

Operations 9

GET /1.3/network List networks #
POST /1.3/network Create SDN network #
GET /1.3/network/interface List interfaces #
POST /1.3/network/interface Create interface #
GET /1.3/network/interface/{uuid} Get interface #
DELETE /1.3/network/interface/{uuid} Delete interface #
GET /1.3/network/{uuid} Get network #
PUT /1.3/network/{uuid} Modify network #
DELETE /1.3/network/{uuid} Delete network #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/upcloud:upcloud-network-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

upcloud-network-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Upcloud Network API
  version: '1.3'
  contact:
    name: UpCloud
    url: https://upcloud.com
    email: hello@upcloud.com
  license:
    name: MIT
    url: https://spdx.org/licenses/MIT.html
  termsOfService: https://upcloud.com/terms-of-service/
  description: 'Operations tagged network across 2 of this provider''s published API definitions: upcloud-openapi.json, upcloud-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.upcloud.com
security:
- apiToken: []
tags:


# --- truncated at 32 KB (34 KB total) ---
# Full source: https://artifacts.apis.io/upcloud/openapi/upcloud-network-api-openapi.yml