file-storage

Modify service

Modifies existing File Storage service by given {service_uuid}.

patch/1.3/file-storage/{service-uuid}

Request

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

Path parameters

service-uuidstring uuid required

The unique identifier.

Example:17fd43a5-a97e-44f7-98a8-0a787da67069

Service UUID

Request body

namestring

A resource name.

configured_status'started' | 'stopped'

The service configured status indicates the service's current intended status. Managed by the customer.

size_gibinteger

The size of the service in gibibytes (GiB)

Example request

{
  "name": "test-name",
  "configured_status": "started",
  "size_gib": 250,
  "networks": [
    {
      "uuid": "03720d07-80a9-41ac-90b0-68a932109339",
      "name": "net",
      "family": "IPv4",
      "ip_address": "192.168.147.120"
    }
  ],
  "labels": [
    {
      "key": "environment",
      "value": "production"
    }
  ]
}

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.