How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
UpCloud

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 networksPublic 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 networkThe 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 LANSDN 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 LANsGenerally, 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).

Documentation Provider Profile APIs.io OpenAPI GitHub

UpCloud Network API is one of 29 APIs that UpCloud publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Networks. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 4 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 1.3.

Requests are made against a single base URL, https://api.upcloud.com.

9 operations 4 paths 28 schemas 2 DELETE4 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.3
Base URL
https://api.upcloud.com
Authentication
HTTP Bearer
Contact
UpCloud
License
MIT
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

UpCloud Network API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (apiToken). By default, every request must be authenticated.

  • apiToken — UpCloud API uses HTTP Bearer authentication. An API token is required to authenticate. The API token can be created in the UpCloud control panel. Alternatively…

Paths & Operations 9

Across 4 paths, the API surfaces 9 operations — 2 DELETE, 4 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Network 9

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

GET
/1.3/network
List networks
listNetworks 1 param → 200default
POST
/1.3/network
Create SDN network
createNetwork body → 201default
GET
/1.3/network/interface
List interfaces
listNetworkInterfaces → 200default
POST
/1.3/network/interface
Create interface
createNetworkInterface body → 201default
GET
/1.3/network/interface/{uuid}
Get interface
getNetworkInterfaceDetails 1 param → 200default
DELETE
/1.3/network/interface/{uuid}
Delete interface
deleteNetworkInterface 1 param → 204default
GET
/1.3/network/{uuid}
Get network
getNetworkDetails 1 param → 200default
PUT
/1.3/network/{uuid}
Modify network
modifyNetwork 1 param body → 200default
DELETE
/1.3/network/{uuid}
Delete network
deleteNetwork 1 param → 204default

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are networkDetails (13 properties), networkInterface (8 properties), networkCreateInterfaceRequest (2 properties), networkLabel (2 properties). Each schema is shown below with its type and property counts.

networkBoolean01
integer
Schema for boolean-like values encoded as 0 or 1.
networkBootfileUrl
string
HTTP or HTTPS URL for DHCP bootfile delivery.
networkLabel
object
A key/value pair to label and categorize resources
2 properties 2 required
networkDetails
object
Detailed network resource attributes.
13 properties 2 required
networkUuid
string
Universally unique identifier
networkIpAddress
IP address
networkCreateInterfaceRequest
object
Request schema for creating a network interface
2 properties
networkName
string
Short name used to identify a tag.
networkIpFamily
string
IP address family
networks
object
Response schema containing a list of networks.
1 property 1 required
networkZone
string
Zone identifier
networkDescription
string
Human-readable description for a tag.
networkPeeringName
string
Name of a network peering relationship.
networkInterface
object
Response schema for listing network interfaces
8 properties 7 required
createNetworkRequest
object
Request schema for creating a network
1 property 1 required
networkError
object
A general error response indicating that the request could not be fulfilled due to a technical issue.
1 property 1 required
networkType
string
Network access type
networkFeatures
string
Features available for a network
network
object
Response schema containing a single network.
1 property 1 required
networkAccountId
integer
Unique numeric identifier of an account.
networkLabels
object
Collection of key/value labels for a resource.
1 property
networkIpCidr
string
IP CIDR
networkServers
object
List of servers associated with the tag.
1 property
modifyNetworkRequest
object
Request schema for modifying a network
1 property 1 required
networkTags
object
Container object for resource tags.
1 property 1 required
networkInterfaces
object
Response schema for listing network interfaces
1 property 1 required
networkPeeringState
string
Current lifecycle state of a network peering.
networkBooleanYesno
string
Boolean value represented as yes/no

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

upcloud-network-api-openapi.yml Raw ↑

Other APIs UpCloud publishes across the network.

UpCloud Account API
AE Profile APIs.io
UpCloud Account Tokens API
AE Profile APIs.io
UpCloud Audit Logs API
AE Profile APIs.io
UpCloud Currency API
AE Profile APIs.io
UpCloud Database API
AE Profile APIs.io
UpCloud Device API
AE Profile APIs.io
UpCloud Events API
AE Profile APIs.io
UpCloud File Storage API
AE Profile APIs.io
UpCloud Firewall Ruleset API
AE Profile APIs.io
UpCloud Gateway API
AE Profile APIs.io
UpCloud Ip Address API
AE Profile APIs.io
UpCloud Kubernetes API
AE Profile APIs.io
#Networks
← Back to U APIs
API Details
ID
upcloud:upcloud-network-api
Base URL
https://api.upcloud.com
Docs
https://developers.upcloud.com/api/1.3
Provider
UpCloud
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=upcloud-network-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/upcloud-network-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of UpCloud Network API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.