storage

List private storage resources

Returns accessible storage resources whose access type is private.

get/1.3/storage/private

Request

Base URL: https://api.upcloud.com
URL: https://api.upcloud.com/1.3/storage/private
Auth: HTTP bearer

Query parameters

labelstring

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

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

searchstring

Partial match against the storage resource title or UUID.

Example:database

Search storage resource titles and UUIDs by partial match.

Storage resource field by which to sort the results.

Example:title

Field by which to sort the results.

order_by'asc' | 'desc'

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

Example:asc

Sort direction. Used only when sort_by is specified.

limitinteger

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

Example:25

Maximum number of storage resources to return.

offsetinteger

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

Number of storage resources to skip before returning results.

Response

A list of storage resources

Example response

{
  "storages": {
    "storage": [
      {
        "access": "private",
        "encrypted": "no",
        "created": "2025-02-27T05:50:50Z",
        "labels": [
          {
            "key": "environment",
            "value": "production"
          }
        ],
        "license": 0,
        "size": 50,
        "state": "online",
        "tier": "maxiops",
        "title": "Production database",
        "type": "normal",
        "uuid": "01f3286c-a5ea-4670-8121-d0b9767d625b",
        "zone": "fi-hel1"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.