Sign in
File Systems

Update file system

Updates the mutable file system configuration. The key is immutable.

patch/v2/file-systems/{file_system_key}

Path parameters

file_system_keystring required

Request body

display_namestring

Update has no key to fall back on, so an explicitly supplied display_name may not be empty; Create defaults an omitted one to the key.

descriptionstring
pathstring
external_access'disabled' | 'read_only' | 'read_write'

Response

File system successfully updated.

idstring

The unique identifier of the file system

keystring required

The unique key of the file system. The key is unique and immutable and cannot be repeated within the same workspace.

display_namestring required

Human readable name shown in the UI

descriptionstring required

The description of the file system. Be as precise as possible to help the AI understand what the file system is for.

project_idstring required

Identifier of the project the file system belongs to

external_access'disabled' | 'read_only' | 'read_write' required
created_by_idstring nullable

The user ID of the creator

updated_by_idstring nullable

The user ID of the last updater

createdstring required

The creation date of the file system

updatedstring required

The last update date of the file system

used_bytesstring nullable

Apparent size of the file system in bytes at the last metering. Absent until first metered.

used_inodesstring nullable

Number of files and directories in the file system at the last metering. Absent until first metered.

last_metered_atstring nullable

When usage was last measured. Absent until first metered.

Changes

Changed in 11 of the 271 revisions of this API.56

Of the 271 revisions, 82 have no diff computed.