UpCloud is a cloud hosting platform used to run virtual servers. UpCloud provides:
- easy creation and hosting of virtual server instances
- management of hosting resources such as servers, storages and IP addresses efficiently
- quickly upscaling and downscaling servers
- migrating servers to different geographical locations
- IPv4 and IPv6 public addresses, IPv4 floating IPs and IPv4 private addresses
- utility network privately connecting all your servers around the globe
- private networks for communication between servers
- firewall services
The billing of resources is done by the hour on a usage basis.
This document describes the Application Programming Interface (API) to UpCloud. It gives information on how to use the API to build applications to control resources such as servers and storages on UpCloud. API client applications can be used to automate regular tasks on the cloud such as creating new servers and to abstract the end user from the cloud service.
This technical document is intended for developers building applications using the UpCloud API. Basic knowledge in programming is required to use the API. The API is independent from any programming language.
Documentation for older API version 1.2 (currently 1.2.8) can be found here.
|1.0.0||Apr 27, 2012||First version of this document.|
|1.0.1||Jul 9, 2012||Added the error code CDROM_EJECT_FAILED to the Eject CD-ROM operation.|
|1.0.2||Oct 3, 2012||Added the new storage resource backup features.|
|1.0.3, 1.1.1||Aug 7, 2013||Added the Modify IP address operation for modifying PTR records. Storages are divided into two tiers:
|1.2.0||Mar 30, 2015||Storage tier
|1.2.1||Apr 29, 2015||Server attribute
|1.2.2||Jul 20, 2015||Server attribute
|1.2.3||Apr 28, 2016||Server creation attributes
|1.2.4||Jul 4, 2016||Firewall rule attribute
|1.2.5||Jun 20, 2017||Server attributes
|1.2.6||Jan 2, 2018||Server operation cancellation added.
|1.2.7||Mar 1, 2018||Flag for setting storages as boot disks and
|1.2.8||Mar 1, 2019||Storages can now be removed during server deletion by adding ?storages=1 to the end of server deletion URI. The platform may rate-limit non-virtio network devices. Other smaller fixes and clarifications.|
|1.3.0||Oct 15, 2019||New software-defined networking stack is now available, allowing custom networks with different features. These can be found from the Networks section, with new features such as API-controlled floating IPs. Private cloud server and host APIs have been introduced. Additionally, server remote access has been revamped, allowing for SPICE connections in addition to older VNC ones.|
|1.3.1||Jan 23, 2020||The accounts endpoint now includes resource limits in effect for the calling account. Network boot feature added.|
|1.3.2||Mar 12, 2020||Simple backup feature added.|
|1.3.3||Mar 30, 2020||Metadata service for servers added.|
|1.3.4||Apr 3, 2020||Subaccount management API added.|
|1.3.5||Aug 7, 2020||Editorial changes, minor error corrections.|
|1.3.6||Oct 22, 2020||Object Storage API added. Servers can be started asynchronously.|
|1.3.7||Nov 16, 2020||Account network transfer usage API added, storage tier added to server responses.|
|1.3.8||Jan 13, 2021||Support selectable ip addresses in
|1.3.9||Apr 19, 2021||Backup deletion parameters when deleting servers or storages added.|
|1.3.10||Apr 26, 2021||More flexible storage attach/detach options.|
Changes from version 1.2
List of incompatible changes from version 1.2
- VNC attributes in server creation, modification and viewing have been replaced by remote access attributes. See 8. Servers for more details.
privateIP address type now refers to the new SDN enabled private networks. The previous semantics of the
privateaddress type are now referred to as
Changes from version 1.1
List of incompatible changes from version 1.1
- IP address and Firewall Rule operations now require
- Customers can now configure servers to avoid certain hosts for added redundancy of environments.