> ## Documentation Index
> Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a CloudFS filesystem

> 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`.



## OpenAPI

````yaml https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/edge-compute.yml patch /storage/cloudfs/{id}
openapi: 3.1.0
info:
  title: Telnyx Edge Compute API
  version: 2.0.0
  description: API for Edge Compute key-value storage (namespaces and keys).
  contact:
    email: support@telnyx.com
servers:
  - url: https://api.telnyx.com/v2
security:
  - bearerAuth: []
paths:
  /storage/cloudfs/{id}:
    patch:
      tags:
        - cloudfs filesystems
      summary: Update a CloudFS filesystem
      description: >-
        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`.
      operationId: UpdateCloudfsFilesystem
      parameters:
        - description: CloudFS filesystem ID
          name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCloudfsFilesystemRequest'
        description: CloudFS filesystem update request
        required: true
      responses:
        '200':
          description: CloudFS filesystem updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudfsFilesystemDetailResponseWrapper'
        '400':
          description: >-
            Bad request — malformed JSON, unknown or immutable field, or missing
            body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/edge-compute_Errors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/edge-compute_Errors'
        '404':
          description: CloudFS filesystem not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/edge-compute_Errors'
        '422':
          description: >-
            Unprocessable entity — `id` is not a valid UUID, the new `name` is
            invalid, or a filesystem with that name already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/edge-compute_Errors'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericErrorResponse'
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import Telnyx from 'telnyx';


            const client = new Telnyx({
              apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
            });


            const CloudfsFilesystemDetailResponseWrapper = await
            client.storage.cloudfs.update('id');


            console.log(CloudfsFilesystemDetailResponseWrapper.data);
        - lang: Python
          source: >-
            import os

            from telnyx import Telnyx


            client = Telnyx(
                api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
            )

            cloudfs_filesystem_detail_response_wrapper =
            client.storage.cloudfs.update(
                id="id",
            )

            print(cloudfs_filesystem_detail_response_wrapper.data)
        - lang: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/team-telnyx/telnyx-go\"\n\t\"github.com/team-telnyx/telnyx-go/option\"\n)\n\nfunc main() {\n\tclient := telnyx.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tcloudf, err := client.Storage.Cloudfs.Update(\n\t\tcontext.TODO(),\n\t\ttelnyx.StorageCloudfsUpdateParams{,\n\t\t\t\tID: \"id\",,\n\t\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", cloudf.Data)\n}\n"
        - lang: Java
          source: |-
            package com.telnyx.sdk.example;

            import com.telnyx.sdk.client.TelnyxClient;
            import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

            public final class Main {
                private Main() {}

                public static void main(String[] args) {
                    TelnyxClient client = TelnyxOkHttpClient.fromEnv();

                    CloudfsFilesystemDetailResponseWrapper response = client.storage()cloudfs()update("id");
                }
            }
        - lang: Ruby
          source: >-
            require "telnyx"


            telnyx = Telnyx::Client.new(api_key: "My API Key")


            cloudfs_filesystem_detail_response_wrapper =
            telnyx.storage.cloudfs.update("id")


            puts(cloudfs_filesystem_detail_response_wrapper)
        - lang: PHP
          source: >-
            <?php


            require_once dirname(__DIR__) . '/vendor/autoload.php';


            use Telnyx\Client;

            use Telnyx\Core\Exceptions\APIException;


            $client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API
            Key');


            try {
              $cloudfs_filesystem_detail_response_wrapper = $client->storage->cloudfs->update(
                'id',
              );

              var_dump($cloudfs_filesystem_detail_response_wrapper);
            } catch (APIException $e) {
              echo $e->getMessage();
            }
        - lang: CLI
          source: |-
            telnyx storage:cloudfs update \
              --api-key 'My API Key' \
              --id id
components:
  schemas:
    UpdateCloudfsFilesystemRequest:
      type: object
      properties:
        name:
          type: string
          description: >-
            New filesystem name, unique within your organization. Names are
            trimmed and lowercased; after normalization they may contain
            lowercase letters, numbers, `.`, `_`, and `-` only.
          pattern: ^[a-z0-9._-]+$
          minLength: 1
          maxLength: 63
          example: agent-fs
    CloudfsFilesystemDetailResponseWrapper:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CloudfsFilesystemDetail'
    edge-compute_Errors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/edge-compute_Error'
    GenericErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/edge-compute_Error'
    CloudfsFilesystemDetail:
      type: object
      description: >-
        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.
      properties:
        record_type:
          type: string
          example: cloudfs
        id:
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        name:
          type: string
          example: agent-fs
        status:
          $ref: '#/components/schemas/CloudfsFilesystemStatus'
        meta_url:
          type: string
          description: >-
            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.
          example: >-
            postgres://fs_0123456789abcdef@us-east-1.telnyxcloudfs.com:5432/fs_0123456789abcdef?sslmode=require
        s3_endpoint:
          type: string
          description: URL of the Telnyx Cloud Storage endpoint backing this filesystem.
          example: https://us-east-1.telnyxcloudstorage.com
        s3_bucket:
          type: string
          description: >-
            Name of the bucket that stores this filesystem's data. Created
            during provisioning.
          example: cloudfs-fs-0123456789abcdef
        region:
          type: string
          example: us-east-1
        error:
          type: string
          description: >-
            Explanation of the most recent failed lifecycle action. Present only
            when the filesystem is in a `failed` state.
          example: failed to create storage bucket
        created_at:
          type: string
          format: date-time
          example: '2026-07-14T21:42:01Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-07-14T21:42:01Z'
    edge-compute_Error:
      type: object
      properties:
        code:
          type: string
          example: '10005'
        detail:
          type: string
          example: The requested function does not exist or you don't have access to it
        meta:
          $ref: '#/components/schemas/ErrorMeta'
        source:
          $ref: '#/components/schemas/ErrorSource'
        title:
          type: string
          example: Function not found
    CloudfsFilesystemStatus:
      type: string
      description: >-
        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.
      enum:
        - provisioning
        - ready
        - needs_format
        - deleting
        - failed
        - deleted
      example: ready
    ErrorMeta:
      type: object
      properties:
        url:
          type: string
          example: https://docs.telnyx.com/api/errors/10005
    ErrorSource:
      type: object
      properties:
        parameter:
          type: string
          example: id
        pointer:
          type: string
          example: /id
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````