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

UpCloud Storage API

Block Storage is similar to a physical hard disk. It can be used to install an operating system or hold another filesystem for a Cloud Server.Writable Block Storage and CD-ROM resources can be freely attached to any Cloud Server within the same zone and under the same account. A maximum of 16 storage devices can be attached to a Cloud Server at the same time; however, the combined limit for network interfaces and storage devices is 24.Storage resource typesThere are four different storage resource types: normal, CD-ROM, template, and backup. The normal type represents writable Block Storage.

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

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

This API exposes 26 operations across 21 paths, and defines 39 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.

26 operations 21 paths 39 schemas 2 DELETE11 GET12 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
License
Terms of Service
Resource Areas
1

Authentication & Security 1

UpCloud Storage 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 26

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

Storage 26

Block Storage is similar to a physical hard disk.

GET
/1.3/storage
List storage resources
getStorageList 6 params → 200400default
POST
/1.3/storage
Create Block Storage
createStorage body → 201default
GET
/1.3/storage/backup
List storage backups
getStorageListByBackup 6 params → 200400default
GET
/1.3/storage/cdrom
List CD-ROM images
getStorageListByCdrom 6 params → 200400default
GET
/1.3/storage/favorite
List favorite storage resources
getFavoriteStorageList → 200default
GET
/1.3/storage/normal
List normal Block Storage
getStorageListByNormal 6 params → 200400default
GET
/1.3/storage/private
List private storage resources
getStorageListByPrivateAccess 6 params → 200400default
GET
/1.3/storage/public
List public storage resources
getStorageListByPublicAccess 6 params → 200400default
GET
/1.3/storage/template
List storage templates
getStorageListByTemplate 6 params → 200400default
GET
/1.3/storage/{type}/{access}
List storage resources by type and access
getStorageListByTypeAndAccess 8 params → 200400default
GET
/1.3/storage/{uuid}
Get storage resource details
getStorageInfo 1 param → 200404default
PUT
/1.3/storage/{uuid}
Modify Block Storage
modifyStorage 1 param body → 200default
DELETE
/1.3/storage/{uuid}
Delete storage resource
deleteStorage 2 params → 204default
POST
/1.3/storage/{uuid}/attach
Attach storage to a Cloud Server
attachStorageToServer 1 param body → 200default
POST
/1.3/storage/{uuid}/backup
Create on-demand backup
createOnDemandBackup 1 param body → 201default
POST
/1.3/storage/{uuid}/cancel
Cancel Block Storage operation
cancelStorageOperation 1 param → 204default
POST
/1.3/storage/{uuid}/clone
Clone Block Storage
cloneStorage 1 param body → 201404default
POST
/1.3/storage/{uuid}/detach
Detach storage from a Cloud Server
detachStorageFromServer 1 param → 200default
POST
/1.3/storage/{uuid}/favorite
Add storage resource to favorites
addStorageToFavorites 1 param → 204default
DELETE
/1.3/storage/{uuid}/favorite
Remove storage resource from favorites
removeStorageFromFavorites 1 param → 204default
GET
/1.3/storage/{uuid}/import
Get storage import details
getStorageImportDetails 1 param → 200404default
POST
/1.3/storage/{uuid}/import
Create storage import
createStorageImport 1 param body → 201400409503default
POST
/1.3/storage/{uuid}/import/cancel
Cancel storage import
cancelStorageImport 1 param → 202404409default
POST
/1.3/storage/{uuid}/resize
Resize Block Storage partition and filesystem
resizeStorage 1 param → 200default
POST
/1.3/storage/{uuid}/restore
Restore Block Storage from backup
restoreStorageFromBackup 1 param → 204default
POST
/1.3/storage/{uuid}/templatize
Create template from Block Storage
createTemplateFromStorage 1 param body → 201default

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are storageDetails (19 properties), storageListItem (16 properties), storageImport (15 properties), storageBackupRule (3 properties). Each schema is shown below with its type and property counts.

detachStorageResponse
object
Response containing the detached storage resource.
1 property 1 required
storageUuid
string
Universally unique identifier
storage
object
Response schema containing a single storage resource.
1 property 1 required
storageOffset
integer
Number of items to skip before starting to return results. Default is 0.
attachStorageResponse
object
Response containing the attached storage resource and its Cloud Server attachment.
1 property 1 required
modifyStorageResponse
object
Response schema for block storage modification operations.
2 properties 1 required
storageAccess
string
Network access level
storages
object
A list of storage resources accessible to the account.
1 property 1 required
storageSearch
string
Partial match against the storage resource title or UUID.
storageError
object
A general error response indicating that the request could not be fulfilled due to a technical issue.
1 property 1 required
cloneStorageRequest
object
Request schema for cloning a block storage resource.
1 property 1 required
storageSortBy
string
Storage resource field by which to sort the results.
storageLabel
object
A key/value pair to label and categorize resources
2 properties 2 required
createStorageResponse
object
Response containing the created block storage resource.
1 property 1 required
createStorageTemplateResponse
object
Response containing the private template being created.
1 property 1 required
storageLabelFilter
string
Label key or key-value pair to match. A key-only filter matches any value. Repeat the query parameter to require all specified labels; keys are matched case-in…
storageListItem
object
Storage resource summary returned by public list operations.
16 properties 9 required
storageTier
string
Block storage performance and pricing tier. maxiops is high-performance block storage, standard is general-purpose block storage, and hdd is the API name for t…
storageType
string
Storage resource type to return.
createStorageBackupResponse
object
Response containing the on-demand backup being created.
1 property 1 required
storageDetails
object
Detailed information about a storage resource.
19 properties 10 required
createStorageRequest
object
Request schema for creating block storage.
1 property 1 required
storageImportResponse
object
Response containing a storage import task.
1 property 1 required
createStorageTemplateRequest
object
Request schema for creating a template from a block storage resource.
1 property 1 required
storageEncrypted
string
Indicates whether the resource is encrypted.
storageZone
string
Zone identifier
storageLimit
integer
Maximum number of storage resources to return. Default is 25.
storageTemplateType
string
Template initialization mechanism. cloud-init templates support cloud-init metadata, while native templates use the operating system's native initialization.
createStorageImportRequest
object
Request schema for creating a storage import task.
1 property 1 required
storageState
string
Current lifecycle state of the storage resource. online is ready for use; maintenance indicates ongoing maintenance or an update; cloning, backuping, and synci…
storageTitle
string
Human-readable title for a resource.
storageAccessFilter
string
Storage resource access type to return.
storageOrderBy
string
Sort direction. This parameter is used only when sortby is specified.
storageBackupRule
object
Schedule for automatic block storage backups.
3 properties 3 required
attachStorageRequest
object
Request schema for attaching this storage resource to a Cloud Server.
1 property 1 required
modifyStorageBody
object
Request schema for modifying block storage properties.
1 property 1 required
createStorageBackupRequest
object
Request schema for creating an on-demand block storage backup.
1 property 1 required
storageImport
object
Details and progress of a storage import task.
15 properties 13 required
resizeStorageResponse
object
Response containing the backup created before resizing the block storage partition and filesystem.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

upcloud-storage-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of UpCloud Storage 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.