file-storage

List services

Returns a list of File Storage services.

get/1.3/file-storage

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/file-storage
  • Auth: HTTP bearer

Query parameters

limitinteger

Schema for the limit query parameter, used to specify the maximum number of items to return in a paginated response.

Number of entries to receive at most.

offsetinteger

Query parameter to specify the offset for pagination in API responses, allowing clients to retrieve results starting from a specific point.

Offset for retrieved results.

sort'created_at' | '-created_at'

Query parameter to specify the sorting order of results in API responses, allowing clients to order data based on specific fields.

Order of returned results.

Response

Success

uuidstring
namestring
zonestring
configured_statusstring
operational_statestring
size_gibinteger
encryptedboolean
created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "configured_status": "started",
    "created_at": "2025-08-01T10:40:04.140473Z",
    "encrypted": false,
    "labels": [
      {
        "key": "environment",
        "value": "production"
      }
    ],
    "name": "test2",
    "networks": [
      {
        "family": "IPv4",
        "ip_address": "10.10.10.50",
        "name": "net",
        "uuid": "0391f203-6eef-4a69-bfcc-fffffbdfdc32"
      }
    ],
    "operational_state": "running",
    "shares": [
      {
        "acl": [
          {
            "name": "test-name",
            "permission": "ro",
            "target": "*"
          }
        ],
        "name": "read",
        "path": "/public"
      },
      {
        "acl": [
          {
            "name": "test-name",
            "permission": "rw",
            "target": "10.10.10.0/24"
          },
          {
            "name": "test-name",
            "permission": "rw",
            "target": "local.domain"
          }
        ],
        "name": "write",
        "path": "/project/data"
      }
    ],
    "size_gib": 250,
    "state_messages": [],
    "updated_at": "2025-08-03T19:23:52.350216Z",
    "uuid": "17871d62-6964-4336-b68d-4a85a8ee10fe",
    "zone": "fi-dev2"
  }
]

Changes

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