UpCloud Server API
Manages Cloud Servers
UpCloud Server API is one of 29 APIs that UpCloud publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Servers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 41 operations across 34 paths, and defines 108 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.
41 operations
34 paths
108 schemas
4 DELETE18 GET16 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
UpCloud Server 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 41
Across 34 paths, the API surfaces 41 operations — 4 DELETE, 18 GET, 16 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
Server 41
Manages Cloud Servers
GET
/1.3/server
List Cloud Servers
POST
/1.3/server
Create a new Cloud Server
GET
/1.3/server/firewall_ruleset_relationships/private/{ruleset_uuid}
List Cloud Servers related to a private firewall ruleset
GET
/1.3/server/labels
List Cloud Server labels
GET
/1.3/server/{uuid}
Get Cloud Server details
PUT
/1.3/server/{uuid}
Modify an existing Cloud Server
DELETE
/1.3/server/{uuid}
Delete a Cloud Server
POST
/1.3/server/{uuid}/attach_firewall_ruleset/private
Attach a private firewall ruleset
POST
/1.3/server/{uuid}/cancel
Cancel a Cloud Server operation
POST
/1.3/server/{uuid}/cdrom/eject
Eject the CD-ROM image from a Cloud Server
POST
/1.3/server/{uuid}/cdrom/load
Load a CD-ROM image into a Cloud Server
POST
/1.3/server/{uuid}/detach_firewall_ruleset/private
Detach a private firewall ruleset
GET
/1.3/server/{uuid}/firewall_rule
List firewall rules
PUT
/1.3/server/{uuid}/firewall_rule
Replace firewall rules
POST
/1.3/server/{uuid}/firewall_rule
Create a firewall rule
GET
/1.3/server/{uuid}/firewall_rule/{position}
Get a firewall rule
DELETE
/1.3/server/{uuid}/firewall_rule/{position}
Delete a firewall rule
GET
/1.3/server/{uuid}/firewall_ruleset_relationships/private
List private firewall ruleset relationships for a Cloud Server
GET
/1.3/server/{uuid}/gpus
List Cloud Server GPUs
GET
/1.3/server/{uuid}/networking
Get Cloud Server networking details
POST
/1.3/server/{uuid}/networking/interface
Add a network interface
PUT
/1.3/server/{uuid}/networking/interface/{index}
Modify a network interface
DELETE
/1.3/server/{uuid}/networking/interface/{index}
Delete a network interface
POST
/1.3/server/{uuid}/networking/interface/{index}/ip_address
Add an IP address to a network interface
DELETE
/1.3/server/{uuid}/networking/interface/{index}/ip_address/{ip}
Delete an IP address from a network interface
POST
/1.3/server/{uuid}/rebuild
Rebuild a Cloud Server
POST
/1.3/server/{uuid}/relocate
Relocate a Cloud Server to another zone
GET
/1.3/server/{uuid}/remote_access_details
Get remote access connection details
POST
/1.3/server/{uuid}/restart
Restart a Cloud Server
POST
/1.3/server/{uuid}/start
Start a Cloud Server
GET
/1.3/server/{uuid}/stats/cpu
Get Cloud Server CPU statistics
GET
/1.3/server/{uuid}/stats/cpu/{period}
Get Cloud Server CPU statistics by period
GET
/1.3/server/{uuid}/stats/disk/{type}
Get Cloud Server disk statistics
GET
/1.3/server/{uuid}/stats/disk/{type}/{period}
Get Cloud Server disk statistics by period
GET
/1.3/server/{uuid}/stats/network/{type}
Get Cloud Server network statistics
GET
/1.3/server/{uuid}/stats/network/{type}/{network}
Get Cloud Server network statistics by network type
GET
/1.3/server/{uuid}/stats/network/{type}/{network}/{period}
Get Cloud Server network statistics by network type and period
POST
/1.3/server/{uuid}/stop
Stop a Cloud Server
POST
/1.3/server/{uuid}/storage/attach
Attach a storage device to a Cloud Server
POST
/1.3/server/{uuid}/storage/detach
Detach a storage device from a Cloud Server
GET
/1.3/server/{uuid}/vnc_details
Get VNC connection details
Schemas 108
The contract defines 108 schemas that model the data the API accepts and returns. The most detailed are serverDetails (40 properties), serverInGetServerList (18 properties), serverFirewallRuleResponseItem (15 properties), serverFirewallRuleItem (14 properties). Each schema is shown below with its type and property counts.
serverRfc3339Datetime
string
Datetime in RFC 3339 format
serverTitle
string
Cloud Server title
server
object
Cloud Server object returned in responses
1 property
1 required
serverStorageDevicesResponse
object
Storage devices attached to a Cloud Server
1 property
1 required
serverNetworkType
string
Network access type
serverModifyInterface
object
Modify network interface request
1 property
1 required
serverReason
string
Schema for reason strings used in API payloads.
serverTags
tags can be an empty array or an object with a tag array
serverFirewallRulesetRelationshipInternal
object
Firewall ruleset relationship with Unix timestamps.
8 properties
8 required
serverVncHost
string
VNC host IP address or noVNC proxy hostname. Empty when no VNC endpoint is assigned.
serverError
object
A general error response indicating that the request could not be fulfilled due to a technical issue.
1 property
1 required
serverNetworkStatsSummary
object
Summarized inbound and outbound network statistics values.
1 property
1 required
serverZone
string
Zone identifier
serverCpuStats
object
CPU usage statistics grouped by period
1 property
1 required
serverCreateDevices
object
Passthrough devices requested for a new Cloud Server
1 property
1 required
serverInterfaceResponse
object
Network interface response
1 property
1 required
serverPlanName
string
Server plan identifier
serverFirewallRuleResponseItem
object
A firewall rule with its position in the Cloud Server's rule chain.
15 properties
15 required
serverPasswordDelivery
string
Password delivery method
serverCoreNumber
integer
Number of CPU cores
serverServerGroup
stringnull
UUID of the server group containing the Cloud Server, or null when the Cloud Server is not in a group.
serverLoginUser
object
Login user configuration for Cloud Server creation
3 properties
serverIpAddressInterfaceResponse
object
IP address response for a network interface
1 property
1 required
serverEncodedHostId
integer
Encoded Private Cloud host ID
serverSimpleBackup
stringnull
Simple backup start time in UTC and frequency, separated by a comma, or no to disable
serverCreateFirewallRule
object
Parameters for creating a firewall rule.
1 property
1 required
serverBooleanYesno
string
Boolean value represented as yes/no
serverInterface
object
Network interface attached to a Cloud Server
7 properties
1 required
serverAddInterface
object
Add network interface request
1 property
1 required
serverLabel
object
A key/value pair to label and categorize resources
2 properties
2 required
firewallRulesetRelatedServers
object
Accessible Cloud Servers related to a private firewall ruleset and their private ruleset relationships.
1 property
1 required
serverBoolean01
integer
Schema for boolean-like values encoded as 0 or 1.
stopServer
object
Stop Cloud Server request
1 property
1 required
serverDetachPrivateFirewallRuleset
object
Parameters for detaching a private firewall ruleset from a Cloud Server.
1 property
1 required
serverError409
object
Conflict error
1 property
1 required
serverError400
object
Bad request error
1 property
1 required
serverDevice
object
Schema for passthrough device information.
4 properties
4 required
serverFirewallRulePort
string
serverPlan
string
Cloud Server plan name
serverLegacyBoolean
string
Boolean value accepted by the legacy API
serverIpAddresses
object
IP addresses assigned to the Cloud Server
1 property
1 required
serverNetworkStats
object
Aggregate inbound and outbound network statistics grouped by period
1 property
1 required
restartServer
object
Restart Cloud Server request
1 property
1 required
serverVncPort
VNC or noVNC proxy port. Empty when no VNC endpoint is assigned.
serverError404
object
Schema for Cloud Server 404 error responses.
1 property
1 required
serverAttachPrivateFirewallRuleset
object
Parameters for attaching a private firewall ruleset to a Cloud Server.
1 property
1 required
serverIpReleasePolicy
string
Action taken when the resource using the address is deleted: release deletes the address, while keep preserves it as a detached floating IP address
serverState
string
Current state of the Cloud Server
serverUpdateFirewallRules
object
Complete replacement for a Cloud Server's firewall rule chain. Array order determines rule positions.
1 property
1 required
serverRemoteAccessType
string
Protocol used for remote access
getServerList
object
Schema for the Cloud Server list response.
1 property
1 required
serverUuid
string
Universally unique identifier
serverIpAddress
IP address
serverVideoModel
string
Video adapter model
serverRemoteAccessDetails
object
Remote access settings and VNC connection details for a Cloud Server
1 property
1 required
serverNicModel
string
Network interface card model
serverCreated
integer
Creation timestamp (Unix epoch time)
serverDetails
object
Detailed public information about a Cloud Server
40 properties
9 required
createServerResponse
object
Newly created Cloud Server and optional one-time login credentials
1 property
1 required
serverLabels
object
Cloud Server labels
1 property
serverAttachStorage
object
Parameters for attaching a storage device to a Cloud Server.
1 property
1 required
serverRemoteAccessPassword
string
Eight-character alphanumeric password used to authenticate remote access
getAllServerLabels
array
Unique label key-value pairs used by accessible Cloud Servers, sorted by key and then value. The array may be empty.
serverInGetServerList
object
Schema for a Cloud Server item returned in Cloud Server list responses.
18 properties
9 required
serverCreateNetworking
object
Network interfaces for a new Cloud Server
1 property
1 required
serverGpus
object
GPUs attached to a Cloud Server. The array is empty when no GPUs are attached.
1 property
1 required
serverInterfaceIpAddress
object
Network interface IP address
5 properties
2 required
serverFirewallRuleItem
object
Firewall rule conditions and action.
14 properties
2 required
startServer
object
Start Cloud Server request
1 property
1 required
serverError403
object
Forbidden error
1 property
1 required
serverAddIpAddress
object
Add IP address to a network interface request
1 property
1 required
serverDiskStats
object
Aggregate disk read and write statistics grouped by period
1 property
1 required
serverHostname
string
Cloud Server hostname
serverFirewallRulesetRelationshipDetails
object
Detailed private firewall ruleset relationship for a Cloud Server.
8 properties
8 required
serverFirewallRulesetRelationship
object
Relationship between a Cloud Server and a firewall ruleset.
3 properties
3 required
serverIpFamily
string
IP address family
serverBootOrder
string
Boot device order (comma-separated list)
serverVncPassword
string
VNC password
serverOffset
integer
Number of items to skip before starting to return results. Default is 0.
serverTagList
string
One or more tag names. Use commas to match any tag, or colons to require all tags.
serverRemoteAccessEnabled
string
Whether remote access is enabled
serverFirewallRulesetRelationships
object
Private firewall ruleset relationships for a Cloud Server.
1 property
1 required
createServer
object
Cloud Server creation parameters
1 property
1 required
relocateServer
object
Relocate Cloud Server request
1 property
1 required
serverFirewallRules
object
Ordered firewall rules configured for a Cloud Server.
1 property
1 required
serverBooleanOnoff
string
Boolean value represented as on/off
serverVncKeymap
string
VNC keyboard layout
serverDiskStatsSummary
object
Summarized disk read and write statistics values.
1 property
1 required
serverCpuStatsSummary
object
Summarized CPU statistics values.
1 property
1 required
serverNetworking
object
Network interfaces configured for the Cloud Server
1 property
serverStatsNetworkType
string
Unit used to measure network activity.
serverMacAddress
string
MAC address
serverDetachStorage
object
Parameters for detaching a storage device from a Cloud Server.
1 property
1 required
serverTimezone
string
Cloud Server timezone
serverFirewallRule
object
A firewall rule with its position in the Cloud Server's rule chain.
1 property
1 required
serverFirewallRuleIcmpType
string
serverFirewallRuleRequirements
object
serverRebuild
object
Rebuild Cloud Server request
1 property
1 required
serverStorageDevices
object
Storage devices to create or attach to the Cloud Server
1 property
1 required
serverNetworkingResponse
object
Cloud Server networking response
1 property
1 required
serverUserName
string
Username for an account.
serverLimit
integer
Maximum number of items to return. Default is 25.
serverStatsPeriod
string
The period for which statistics are calculated.
serverMemoryAmount
integer
Amount of memory in MB
serverUserData
string
Setup script body or URL processed during Cloud Server initialization
modifyServer
object
Fields that can be changed on an existing Cloud Server
1 property
1 required
serverError511
object
Operation failed error
1 property
1 required
serverLoadCdrom
object
Parameters for loading a storage into a Cloud Server's CD-ROM device.
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from UpCloud 12
Other APIs UpCloud publishes across the network.
UpCloud Account API
UpCloud Account Tokens API
UpCloud Audit Logs API
UpCloud Currency API
UpCloud Database API
UpCloud Device API
UpCloud Events API
UpCloud File Storage API
UpCloud Firewall Ruleset API
UpCloud Gateway API
UpCloud Ip Address API
UpCloud Kubernetes API
#Servers
Where this information came from
This is an independent, third-party profile of UpCloud Server 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.