---
title: "Update a CloudFS filesystem"
method: PATCH
path: "/storage/cloudfs/{id}"
tags: ["cloudfs filesystems"]
---

# Update a CloudFS filesystem

`PATCH /storage/cloudfs/{id}`

## Request

- Base URL: `https://api.telnyx.com/v2`
- URL: `https://api.telnyx.com/v2/storage/cloudfs/{id}`
- Auth: HTTP bearer

Updates a CloudFS filesystem. Only `name` can be changed; other fields are immutable and unknown fields are rejected with a `400`. Renaming to a name that already exists in your organization returns a `422`.

## Path parameters

- `id` string, uuid, required

## Request body

- UpdateCloudfsFilesystemRequest
  - `name` string: New filesystem name, unique within your organization. Names are trimmed and lowercased; after normalization they may contain lowercase letters, numbers, `.`, `_`, and `-` only.

## Response `200`

CloudFS filesystem updated successfully

- CloudfsFilesystemDetailResponseWrapper
  - `data` CloudfsFilesystemDetail: A CloudFS filesystem as returned by get, update, and delete. `meta_url` omits the credential and there is no `meta_token` field — the token is only returned by create and rotate-meta-token.
    - `record_type` string
    - `id` string, uuid
    - `name` string
    - `status` 'provisioning' | 'ready' | 'needs_format' | 'deleting' | 'failed' | 'deleted': Lifecycle status of the filesystem. `ready` means it is fully provisioned and usable. `needs_format` means the storage bucket and metadata database were provisioned but the filesystem has not yet been formatted — run `juicefs format` with the filesystem's `meta_url` before mounting. `failed` means the last lifecycle action failed — see the filesystem's `error` message. `deleted` appears only in the delete response: deleted filesystems are excluded from list results and return a `404` on retrieval.
    - `meta_url` string: PostgreSQL connection URL for the filesystem's metadata database, without the credential. Combine it with your stored metadata token, or issue a new token with rotate-meta-token.
    - `s3_endpoint` string: URL of the Telnyx Cloud Storage endpoint backing this filesystem.
    - `s3_bucket` string: Name of the bucket that stores this filesystem's data. Created during provisioning.
    - `region` string
    - `error` string: Explanation of the most recent failed lifecycle action. Present only when the filesystem is in a `failed` state.
    - `created_at` string, date-time
    - `updated_at` string, date-time

## Other responses

- `400`: Bad request — malformed JSON, unknown or immutable field, or missing body
- `401`: Unauthorized
- `404`: CloudFS filesystem not found
- `422`: Unprocessable entity — `id` is not a valid UUID, the new `name` is invalid, or a filesystem with that name already exists
- `500`: Internal server error

## Changes

- **2026-10-21** `67df31283a8a`: 4 breaking, 4 info
  - the `errors/items/code` response's property type changed from `integer` to `string`, and format from `int32` to no format for status `400`
  - the `errors/items/code` response's property type changed from `integer` to `string`, and format from `int32` to no format for status `401`
  - the `errors/items/code` response's property type changed from `integer` to `string`, and format from `int32` to no format for status `404`
  - the `errors/items/code` response's property type changed from `integer` to `string`, and format from `int32` to no format for status `422`
  - …4 more
- **2026-10-15** `a72569d69430`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/team-telnyx/apis/telnyx-api/changes/storage/cloudfs/:id/patch.md)

---

[API](https://skmtc.dev/team-telnyx/apis/telnyx-api.md) - [All operations](https://skmtc.dev/team-telnyx/apis/telnyx-api/llms.txt) - [OpenAPI document](https://skmtc.dev/team-telnyx/apis/telnyx-api/revisions/a73101b68823?raw)