Compute Cloud API, REST: Filesystem.Update

Written by

Updated at December 1, 2025

HTTP request
Path parameters
Body parameters
Response
UpdateFilesystemMetadata
Status
Filesystem

Updates the specified filesystem.

HTTP request

PATCH https://compute.api.cloud.yandex.net/compute/v1/filesystems/{filesystemId}

Path parameters

Field

Description

filesystemId

string

Required field. ID of the filesystem to update.

To get the filesystem ID, make a FilesystemService.List request.

The maximum string length in characters is 50.

Body parameters

{
  "updateMask": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "size": "string"
}

Field	Description
updateMask	string (field-mask) A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in `updateMask` and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0. If `updateMask` is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.
name	string New name of the filesystem. The name must be unique within the folder. Value must match the regular expression `\\|[a-z]([-_a-z0-9]{0,61}[a-z0-9])?`.
description	string New description of the filesystem. The maximum string length in characters is 256.
labels	object (map<string, string>) New filesystem labels as `key:value` pairs. For details about the concept, see documentation. Existing set of labels is completely replaced by the provided set, so if you just want to add or remove a label: Get the current set of labels with a FilesystemService.Get request. Add or remove a label in this set. Send the new set in this field. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression `[-_./\@0-9a-z]`. The string length in characters for each key must be 1-63. Each key must match the regular expression `[a-z][-_./\@0-9a-z]`.
size	string (int64) Size of the filesystem, specified in bytes.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "filesystemId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "folderId": "string",
    "createdAt": "string",
    "name": "string",
    "description": "string",
    "labels": "object",
    "typeId": "string",
    "zoneId": "string",
    "size": "string",
    "blockSize": "string",
    "status": "string"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
done	boolean If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	UpdateFilesystemMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	Filesystem The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

UpdateFilesystemMetadata

Field

Description

filesystemId

string

ID of the filesystem that is being updated.

Status

The error result of the operation in case of failure or cancellation.

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

Filesystem

A filesystem resource.
For details about the concept, see documentation.

Field	Description
id	string ID of the filesystem. Generated at creation time.
folderId	string ID of the folder that the filesystem belongs to.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
name	string Name of the filesystem. The name is unique within the folder.
description	string Description of the filesystem.
labels	object (map<string, string>) Filesystem labels as `key:value` pairs. For details about the concept, see documentation.
typeId	string ID of the filesystem type. To get a list of available filesystem types, make a yandex.cloud.compute.v1.DiskTypeService.List request.
zoneId	string ID of the availability zone where the filesystem resides. A filesystem can be attached only to instances residing in the same availability zone.
size	string (int64) Size of the filesystem, specified in bytes.
blockSize	string (int64) Block size used for the filesystem, specified in bytes.
status	enum (Status) Current status of the filesystem. `CREATING`: The filesystem is being created. `READY`: The filesystem is ready to use. `ERROR`: The filesystem encountered a problem and cannot operate. `DELETING`: The filesystem is being deleted.

Compute Cloud API, REST: Filesystem.Update

HTTP requestHTTP request

Path parametersPath parameters

Body parametersBody parameters

ResponseResponse

UpdateFilesystemMetadataUpdateFilesystemMetadata

StatusStatus

FilesystemFilesystem

Was the article helpful?