Block Storage

Download schema

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 types

There are four different storage resource types: normal, CD-ROM, template, and backup. The normal type represents writable Block Storage.

List storage resources

GET

https://api.upcloud.com

/1.3/storage

Returns all storage resources accessible to the account. The results can be filtered by labels or a title and UUID search, sorted, and paginated.

List storage resources › query Parameters

label

storageLabelFilter · pattern: ^(?!_)[\x20-\x3C\x3E…

Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.

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-insensitively.

Example: environment

search

storageSearch · minLength: 1 · maxLength: 255 · pattern: ^[^<>]+$

Search storage resource titles and UUIDs by partial match.

Partial match against the storage resource title or UUID.

Example: database

sort_by

storageSortBy · enum

Field by which to sort the results.

Storage resource field by which to sort the results.

Enum values:

created

size

tier

title

type

zone

Example: title

order_by

storageOrderBy · enum

Sort direction. Used only when sort_by is specified.

Sort direction. This parameter is used only when sort_by is specified.

Enum values:

asc

desc

Example: asc

limit

storageLimit · min: 1 · max: 100

Maximum number of storage resources to return.

Maximum number of storage resources to return. Default is 25.

Example: 25

offset

storageOffset · min: 0

Number of storage resources to skip before returning results.

Number of items to skip before starting to return results. Default is 0.

Example: 0

List storage resources › Responses

A list of storage resources

A list of storage resources accessible to the account.

storages

object · required

Create Block Storage

POST

https://api.upcloud.com

/1.3/storage

Creates a block storage resource in a specific zone. The new block storage is not attached to a Cloud Server.

Create Block Storage › Request Body

Request schema for creating block storage.

createStorageRequest

object · required

Block storage creation parameters.

Create Block Storage › Responses

Block storage created

Response containing the created block storage resource.

createStorageResponse

storageDetails · required

Detailed information about a storage resource.

POST/1.3/storage

curl https://api.upcloud.com/1.3/storage \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "storage": {
    "backup_rule": {
      "interval": "daily",
      "retention": "7",
      "time": "0400"
    },
    "encrypted": "yes",
    "labels": [
      {
        "key": "environment",
        "value": "production"
      }
    ],
    "size": 50,
    "tier": "maxiops",
    "title": "Block Storage 1",
    "zone": "fi-hel1"
  }
}'

Example Request Body

{
  "storage": {
    "backup_rule": {
      "interval": "daily",
      "retention": "7",
      "time": "0400"
    },
    "encrypted": "yes",
    "labels": [
      {
        "key": "environment",
        "value": "production"
      }
    ],
    "size": 50,
    "tier": "maxiops",
    "title": "Block Storage 1",
    "zone": "fi-hel1"
  }
}

json

Example Responses

{
  "storage": {
    "access": "private",
    "backup_rule": {
      "interval": "daily",
      "retention": "7",
      "time": "0400"
    },
    "backups": {
      "backup": []
    },
    "created": "2026-08-26T09:15:00Z",
    "encrypted": "yes",
    "labels": [
      {
        "key": "environment",
        "value": "production"
      }
    ],
    "license": 0,
    "servers": {
      "server": []
    },
    "size": 50,
    "state": "online",
    "tier": "maxiops",
    "title": "Production data",
    "type": "normal",
    "uuid": "01d4fcd4-e446-433b-8a9c-551a1284952e",
    "zone": "fi-hel1"
  }
}

json

application/json

List storage backups

GET

https://api.upcloud.com

/1.3/storage/backup

Returns accessible storage resources whose type is backup.

List storage backups › query Parameters

label

storageLabelFilter · pattern: ^(?!_)[\x20-\x3C\x3E…

Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.

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-insensitively.

Example: environment

search

storageSearch · minLength: 1 · maxLength: 255 · pattern: ^[^<>]+$

Search storage resource titles and UUIDs by partial match.

Partial match against the storage resource title or UUID.

Example: database

sort_by

storageSortBy · enum

Field by which to sort the results.

Storage resource field by which to sort the results.

Enum values:

created

size

tier

title

type

zone

Example: title

order_by

storageOrderBy · enum

Sort direction. Used only when sort_by is specified.

Sort direction. This parameter is used only when sort_by is specified.

Enum values:

asc

desc

Example: asc

limit

storageLimit · min: 1 · max: 100

Maximum number of storage resources to return.

Maximum number of storage resources to return. Default is 25.

Example: 25

offset

storageOffset · min: 0

Number of storage resources to skip before returning results.

Number of items to skip before starting to return results. Default is 0.

Example: 0

List storage backups › Responses

A list of storage resources

A list of storage resources accessible to the account.

storages

object · required

List CD-ROM images

GET

https://api.upcloud.com

/1.3/storage/cdrom

Returns accessible storage resources whose type is cdrom.

List CD-ROM images › query Parameters

label

storageLabelFilter · pattern: ^(?!_)[\x20-\x3C\x3E…

Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.

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-insensitively.

Example: environment

search

storageSearch · minLength: 1 · maxLength: 255 · pattern: ^[^<>]+$

Search storage resource titles and UUIDs by partial match.

Partial match against the storage resource title or UUID.

Example: database

sort_by

storageSortBy · enum

Field by which to sort the results.

Storage resource field by which to sort the results.

Enum values:

created

size

tier

title

type

zone

Example: title

order_by

storageOrderBy · enum

Sort direction. Used only when sort_by is specified.

Sort direction. This parameter is used only when sort_by is specified.

Enum values:

asc

desc

Example: asc

limit

storageLimit · min: 1 · max: 100

Maximum number of storage resources to return.

Maximum number of storage resources to return. Default is 25.

Example: 25

offset

storageOffset · min: 0

Number of storage resources to skip before returning results.

Number of items to skip before starting to return results. Default is 0.

Example: 0

List CD-ROM images › Responses

A list of storage resources

A list of storage resources accessible to the account.

storages

object · required

List favorite storage resources

GET

https://api.upcloud.com

/1.3/storage/favorite

Returns the public templates and CD-ROM images that the account has marked as favorites.

List favorite storage resources › Responses

A list of favorite storage resources

A list of storage resources accessible to the account.

storages

object · required

List normal Block Storage

GET

https://api.upcloud.com

/1.3/storage/normal

Returns accessible Block Storage resources whose type is normal.

List normal Block Storage › query Parameters

label

storageLabelFilter · pattern: ^(?!_)[\x20-\x3C\x3E…

Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.

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-insensitively.

Example: environment

search

storageSearch · minLength: 1 · maxLength: 255 · pattern: ^[^<>]+$

Search storage resource titles and UUIDs by partial match.

Partial match against the storage resource title or UUID.

Example: database

sort_by

storageSortBy · enum

Field by which to sort the results.

Storage resource field by which to sort the results.

Enum values:

created

size

tier

title

type

zone

Example: title

order_by

storageOrderBy · enum

Sort direction. Used only when sort_by is specified.

Sort direction. This parameter is used only when sort_by is specified.

Enum values:

asc

desc

Example: asc

limit

storageLimit · min: 1 · max: 100

Maximum number of storage resources to return.

Maximum number of storage resources to return. Default is 25.

Example: 25

offset

storageOffset · min: 0

Number of storage resources to skip before returning results.

Number of items to skip before starting to return results. Default is 0.

Example: 0

List normal Block Storage › Responses

A list of storage resources

A list of storage resources accessible to the account.

storages

object · required

List private storage resources

GET

https://api.upcloud.com

/1.3/storage/private

Returns accessible storage resources whose access type is private.

List private storage resources › query Parameters

label

storageLabelFilter · pattern: ^(?!_)[\x20-\x3C\x3E…

Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.

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-insensitively.

Example: environment

search

storageSearch · minLength: 1 · maxLength: 255 · pattern: ^[^<>]+$

Search storage resource titles and UUIDs by partial match.

Partial match against the storage resource title or UUID.

Example: database

sort_by

storageSortBy · enum

Field by which to sort the results.

Storage resource field by which to sort the results.

Enum values:

created

size

tier

title

type

zone

Example: title

order_by

storageOrderBy · enum

Sort direction. Used only when sort_by is specified.

Sort direction. This parameter is used only when sort_by is specified.

Enum values:

asc

desc

Example: asc

limit

storageLimit · min: 1 · max: 100

Maximum number of storage resources to return.

Maximum number of storage resources to return. Default is 25.

Example: 25

offset

storageOffset · min: 0

Number of storage resources to skip before returning results.

Number of items to skip before starting to return results. Default is 0.

Example: 0

List private storage resources › Responses

A list of storage resources

A list of storage resources accessible to the account.

storages

object · required

List public storage resources

GET

https://api.upcloud.com

/1.3/storage/public

Returns accessible storage resources whose access type is public.

List public storage resources › query Parameters

label

storageLabelFilter · pattern: ^(?!_)[\x20-\x3C\x3E…

Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.

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-insensitively.

Example: environment

search

storageSearch · minLength: 1 · maxLength: 255 · pattern: ^[^<>]+$

Search storage resource titles and UUIDs by partial match.

Partial match against the storage resource title or UUID.

Example: database

sort_by

storageSortBy · enum

Field by which to sort the results.

Storage resource field by which to sort the results.

Enum values:

created

size

tier

title

type

zone

Example: title

order_by

storageOrderBy · enum

Sort direction. Used only when sort_by is specified.

Sort direction. This parameter is used only when sort_by is specified.

Enum values:

asc

desc

Example: asc

limit

storageLimit · min: 1 · max: 100

Maximum number of storage resources to return.

Maximum number of storage resources to return. Default is 25.

Example: 25

offset

storageOffset · min: 0

Number of storage resources to skip before returning results.

Number of items to skip before starting to return results. Default is 0.

Example: 0

List public storage resources › Responses

A list of storage resources

A list of storage resources accessible to the account.

storages

object · required

List storage templates

GET

https://api.upcloud.com

/1.3/storage/template

Returns accessible storage resources whose type is template.

List storage templates › query Parameters

label

storageLabelFilter · pattern: ^(?!_)[\x20-\x3C\x3E…

Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.

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-insensitively.

Example: environment

search

storageSearch · minLength: 1 · maxLength: 255 · pattern: ^[^<>]+$

Search storage resource titles and UUIDs by partial match.

Partial match against the storage resource title or UUID.

Example: database

sort_by

storageSortBy · enum

Field by which to sort the results.

Storage resource field by which to sort the results.

Enum values:

created

size

tier

title

type

zone

Example: title

order_by

storageOrderBy · enum

Sort direction. Used only when sort_by is specified.

Sort direction. This parameter is used only when sort_by is specified.

Enum values:

asc

desc

Example: asc

limit

storageLimit · min: 1 · max: 100

Maximum number of storage resources to return.

Maximum number of storage resources to return. Default is 25.

Example: 25

offset

storageOffset · min: 0

Number of storage resources to skip before returning results.

Number of items to skip before starting to return results. Default is 0.

Example: 0

List storage templates › Responses

A list of storage resources

A list of storage resources accessible to the account.

storages

object · required

List storage resources by type and access

GET

https://api.upcloud.com

/1.3/storage/{type}/{access}

Returns accessible storage resources matching both the requested storage type and access type.

List storage resources by type and access › path Parameters

type

storageType · enum · required

Storage resource type to return.

Enum values:

normal

template

cdrom

backup

Example: normal

access

storageAccessFilter · enum · required

Storage resource access type to return.

Enum values:

public

private

Example: private

List storage resources by type and access › query Parameters

label

storageLabelFilter · pattern: ^(?!_)[\x20-\x3C\x3E…

Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.

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-insensitively.

Example: environment

search

storageSearch · minLength: 1 · maxLength: 255 · pattern: ^[^<>]+$

Search storage resource titles and UUIDs by partial match.

Partial match against the storage resource title or UUID.

Example: database

sort_by

storageSortBy · enum

Field by which to sort the results.

Storage resource field by which to sort the results.

Enum values:

created

size

tier

title

type

zone

Example: title

order_by

storageOrderBy · enum

Sort direction. Used only when sort_by is specified.

Sort direction. This parameter is used only when sort_by is specified.

Enum values:

asc

desc

Example: asc

limit

storageLimit · min: 1 · max: 100

Maximum number of storage resources to return.

Maximum number of storage resources to return. Default is 25.

Example: 25

offset

storageOffset · min: 0

Number of storage resources to skip before returning results.

Number of items to skip before starting to return results. Default is 0.

Example: 0

List storage resources by type and access › Responses

A list of storage resources

A list of storage resources accessible to the account.

storages

object · required

Get storage resource details

GET

https://api.upcloud.com

/1.3/storage/{uuid}

Returns detailed information about a storage resource, including its current state, attachments, labels, and backup configuration when applicable.

Get storage resource details › path Parameters

uuid

storageUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

Storage resource UUID

Universally unique identifier

Get storage resource details › Responses

Storage resource details

Response schema containing a single storage resource.

storage

storageDetails · required

Detailed information about a storage resource.

Modify Block Storage

PUT

https://api.upcloud.com

/1.3/storage/{uuid}

Modifies a block storage title, labels, automatic backup rule, or size. A new size must be greater than the current size. Set filesystem_resize to yes to also resize the last partition and its supported filesystem after increasing the block storage size.

Modify Block Storage › path Parameters

uuid

storageUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

Block storage UUID

Universally unique identifier

Modify Block Storage › Request Body

Request schema for modifying block storage properties.

modifyStorageBody

object · required

Block storage properties to modify.

Modify Block Storage › Responses

Block storage modified

Response schema for block storage modification operations.

modifyStorageResponse

storageDetails · required

Detailed information about a storage resource.

storageDetails

Detailed information about a storage resource.

PUT/1.3/storage/{uuid}

curl https://api.upcloud.com/1.3/storage/:uuid \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "storage": {
    "size": 100,
    "title": "Production data expanded"
  }
}'

Example Request Body

{
  "storage": {
    "size": 100,
    "title": "Production data expanded"
  }
}

json

Example Responses

{
  "storage": {
    "access": "private",
    "backup_rule": {},
    "backups": {
      "backup": []
    },
    "created": "2026-08-26T09:15:00Z",
    "encrypted": "no",
    "labels": [],
    "license": 0,
    "servers": {
      "server": []
    },
    "size": 60,
    "state": "online",
    "tier": "maxiops",
    "title": "Production data expanded",
    "type": "normal",
    "uuid": "011d671f-e803-484d-920a-c25b4bb05c01",
    "zone": "fi-hel1"
  }
}

json

application/json

Delete storage resource

DELETE

https://api.upcloud.com

/1.3/storage/{uuid}

Schedules an unattached private storage resource for deletion. Associated backups are kept by default unless another backup policy is selected.

Delete storage resource › path Parameters

uuid

storageUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

Storage resource UUID

Universally unique identifier

Delete storage resource › query Parameters

backups

string · enum

Policy for handling backups when deleting a storage resource. Defaults to keep. Allowed values: keep, delete, keep_latest

Enum values:

keep

delete

keep_latest

Delete storage resource › Responses

Storage resource deleted

No data returned

Attach storage to a Cloud Server

POST

https://api.upcloud.com

/1.3/storage/{uuid}/attach

Attaches the storage resource to a Cloud Server in the same zone. The device defaults to a disk at the next available address. IDE and CD-ROM devices can be attached only while the Cloud Server is stopped; SCSI and VirtIO disks can also be attached while it is running.

Attach storage to a Cloud Server › path Parameters

uuid

storageUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

Storage resource UUID

Universally unique identifier

Attach storage to a Cloud Server › Request Body

Request schema for attaching this storage resource to a Cloud Server.

attachStorageRequest

object · required

Parameters for attaching this storage resource to a Cloud Server in the same zone.

Attach storage to a Cloud Server › Responses

Storage resource attached to Cloud Server

Response containing the attached storage resource and its Cloud Server attachment.

attachStorageResponse

storageDetails · required

Detailed information about a storage resource.

POST/1.3/storage/{uuid}/attach

curl https://api.upcloud.com/1.3/storage/:uuid/attach \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "storage_device": {
    "server": "00798b85-efdc-41ca-8021-f6ef457b8531",
    "type": "disk"
  }
}'

Example Request Body

{
  "storage_device": {
    "server": "00798b85-efdc-41ca-8021-f6ef457b8531",
    "type": "disk"
  }
}

json

Example Responses

{
  "storage": {
    "access": "private",
    "backup_rule": {},
    "backups": {
      "backup": []
    },
    "created": "2026-08-26T09:15:00Z",
    "encrypted": "yes",
    "labels": [
      {
        "key": "environment",
        "value": "production"
      }
    ],
    "license": 0,
    "servers": {
      "server": [
        "009d64ef-31d1-4684-a26b-c86c955cbf46"
      ]
    },
    "size": 50,
    "state": "online",
    "tier": "maxiops",
    "title": "Production data",
    "type": "normal",
    "uuid": "01d4fcd4-e446-433b-8a9c-551a1284952e",
    "zone": "fi-hel1"
  }
}

json

application/json

Create on-demand backup

POST

https://api.upcloud.com

/1.3/storage/{uuid}/backup

Creates a point-in-time backup of private normal block storage. The operation is asynchronous: the source block storage is backuping while the backup is created, and the returned backup remains in maintenance until it is ready.

Create on-demand backup › path Parameters

uuid

storageUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

Block storage UUID

Universally unique identifier

Create on-demand backup › Request Body

Request schema for creating an on-demand block storage backup.

createStorageBackupRequest

object · required

Parameters for the point-in-time backup.

Create on-demand backup › Responses

On-demand backup created

Response containing the on-demand backup being created.

createStorageBackupResponse

storageDetails · required

Detailed information about a storage resource.

POST/1.3/storage/{uuid}/backup

curl https://api.upcloud.com/1.3/storage/:uuid/backup \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "storage": {
    "title": "Manually created backup"
  }
}'

Example Request Body

{
  "storage": {
    "title": "Manually created backup"
  }
}

json

Example Responses

{
  "storage": {
    "access": "private",
    "created": "2026-08-26T09:20:00Z",
    "encrypted": "yes",
    "labels": [
      {
        "key": "environment",
        "value": "production"
      }
    ],
    "license": 0,
    "origin": "01d4fcd4-e446-433b-8a9c-551a1284952e",
    "progress": "0",
    "servers": {
      "server": []
    },
    "size": 50,
    "state": "maintenance",
    "title": "Manually created backup",
    "type": "backup",
    "uuid": "016d343b-14de-4b61-91ca-433dd1ea6c47",
    "zone": "fi-hel1"
  }
}

json

application/json

Cancel Block Storage operation

POST

https://api.upcloud.com

/1.3/storage/{uuid}/cancel

Requests cancellation of an interruptible operation on block storage in the maintenance state. For a running clone, cancellation removes the incomplete copy and returns the source block storage to the online state.

Cancel Block Storage operation › path Parameters

uuid

storageUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

Block storage UUID

Universally unique identifier

Cancel Block Storage operation › Responses

Block storage operation cancelled

No data returned

Clone Block Storage

POST

https://api.upcloud.com

/1.3/storage/{uuid}/clone

Creates a Block Storage copy of a storage resource. Cloning is asynchronous: the returned block storage remains in the maintenance state until the operation completes and can be monitored with the storage resource details endpoint.

Clone Block Storage › path Parameters

uuid

storageUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

Storage resource UUID

Universally unique identifier

Clone Block Storage › Request Body

Request schema for cloning a block storage resource.

cloneStorageRequest

object · required

Parameters for the cloned block storage.

Clone Block Storage › Responses

Block storage cloned

Response containing the created block storage resource.

createStorageResponse

storageDetails · required

Detailed information about a storage resource.

POST/1.3/storage/{uuid}/clone

curl https://api.upcloud.com/1.3/storage/:uuid/clone \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "storage": {
    "encrypted": "yes",
    "tier": "maxiops",
    "title": "Cloned Block Storage",
    "zone": "fi-hel1"
  }
}'

Example Request Body

{
  "storage": {
    "encrypted": "yes",
    "tier": "maxiops",
    "title": "Cloned Block Storage",
    "zone": "fi-hel1"
  }
}

json

Example Responses

{
  "storage": {
    "access": "private",
    "backup_rule": {
      "interval": "daily",
      "retention": "7",
      "time": "0400"
    },
    "backups": {
      "backup": []
    },
    "created": "2026-08-26T09:15:00Z",
    "encrypted": "yes",
    "labels": [
      {
        "key": "environment",
        "value": "production"
      }
    ],
    "license": 0,
    "servers": {
      "server": []
    },
    "size": 50,
    "state": "online",
    "tier": "maxiops",
    "title": "Production data",
    "type": "normal",
    "uuid": "01d4fcd4-e446-433b-8a9c-551a1284952e",
    "zone": "fi-hel1"
  }
}

json

application/json

Detach storage from a Cloud Server

POST

https://api.upcloud.com

/1.3/storage/{uuid}/detach

Detaches the storage resource from its attached Cloud Server. IDE and CD-ROM devices can be detached only while the Cloud Server is stopped; SCSI and VirtIO disks can also be detached while it is running. If the storage resource is already detached, it is returned unchanged.

Detach storage from a Cloud Server › path Parameters

uuid

storageUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

Storage resource UUID

Universally unique identifier

Detach storage from a Cloud Server › Responses

Storage resource detached from Cloud Server

Response containing the detached storage resource.

detachStorageResponse

storageDetails · required

Detailed information about a storage resource.

Add storage resource to favorites

POST

https://api.upcloud.com

/1.3/storage/{uuid}/favorite

Adds an accessible storage resource to the account's favorites. The operation succeeds if the storage resource is already a favorite.

Add storage resource to favorites › path Parameters

uuid

storageUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

Storage resource UUID

Universally unique identifier

Add storage resource to favorites › Responses

Storage resource added to favorites

No data returned

Remove storage resource from favorites

DELETE

https://api.upcloud.com

/1.3/storage/{uuid}/favorite

Removes an accessible storage resource from the account's favorites. The operation succeeds if the storage resource is not a favorite.

Remove storage resource from favorites › path Parameters

uuid

storageUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

Storage resource UUID

Universally unique identifier

Remove storage resource from favorites › Responses

Storage resource removed from favorites

No data returned

Resize Block Storage partition and filesystem

POST

https://api.upcloud.com

/1.3/storage/{uuid}/resize

Resizes the last partition and its supported filesystem to use the block storage capacity already available. A backup is created before the operation and returned on success. Increase the block storage capacity first with the modify block storage endpoint.

Resize Block Storage partition and filesystem › path Parameters

uuid

storageUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

Block storage UUID

Universally unique identifier

Resize Block Storage partition and filesystem › Responses

Block storage resize started

Response containing the backup created before resizing the block storage partition and filesystem.

resizeStorageResponse

storageDetails · required

Detailed information about a storage resource.

Restore Block Storage from backup

POST

https://api.upcloud.com

/1.3/storage/{uuid}/restore

Starts restoring the backup identified by uuid to its origin block storage. If the origin block storage is attached to a Cloud Server, the Cloud Server must be stopped.

Restore Block Storage from backup › path Parameters

uuid

storageUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

Backup UUID

Universally unique identifier

Restore Block Storage from backup › Responses

Block storage restore started

No data returned

Create template from Block Storage

POST

https://api.upcloud.com

/1.3/storage/{uuid}/templatize

Creates a private template from private normal block storage. The operation is asynchronous: the returned template remains in maintenance until it is ready. Deployments from the template use the source block storage tier.

Create template from Block Storage › path Parameters

uuid

storageUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

Block storage UUID

Universally unique identifier

Create template from Block Storage › Request Body

Request schema for creating a template from a block storage resource.

createStorageTemplateRequest

object · required

Parameters for creating a template from the block storage.

Create template from Block Storage › Responses

Template created

Response containing the private template being created.

createStorageTemplateResponse

storageDetails · required

Detailed information about a storage resource.

POST/1.3/storage/{uuid}/templatize

curl https://api.upcloud.com/1.3/storage/:uuid/templatize \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "storage": {
    "title": "My server template"
  }
}'

Example Request Body

{
  "storage": {
    "title": "My server template"
  }
}

json

Example Responses

{
  "storage": {
    "access": "private",
    "created": "2026-08-26T09:25:00Z",
    "encrypted": "yes",
    "labels": [
      {
        "key": "environment",
        "value": "production"
      }
    ],
    "license": 0,
    "servers": {
      "server": []
    },
    "size": 50,
    "state": "maintenance",
    "tier": "maxiops",
    "title": "My server template",
    "type": "template",
    "uuid": "01be94b8-8f9f-44f7-99df-3d61051173c2",
    "zone": "fi-hel1"
  }
}

json

application/json

Partner Object Storage