---
title: "List CloudFS filesystems"
method: GET
path: "/storage/cloudfs"
tags: ["cloudfs filesystems"]
---

# List CloudFS filesystems

`GET /storage/cloudfs`

Lists the CloudFS filesystems for the authenticated user's organization. Results use cursor-based pagination: fetch the next page by passing `meta.cursors.after` as `page[after]`, or follow the `meta.next` URL.

## Query parameters

- `page[limit]` integer
- `page[after]` string
- `page[before]` string
- `filter[name]` string
- `filter[status]` 'provisioning' | 'ready' | 'needs_format' | 'deleting' | 'failed'
- `filter[region]` string
- `sort` 'created_at' | '-created_at' | 'updated_at' | '-updated_at' | 'name' | '-name'

## Response `200`

CloudFS filesystems retrieved successfully

- CloudfsFilesystemListResponseWrapper
  - `data` CloudfsFilesystemListItem[]
    - `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.
    - `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
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `meta` CloudfsListMeta
    - `cursors` CloudfsListCursors — Opaque cursors for the adjacent pages. Empty when there are no adjacent pages.
      - `after` string — Cursor for the next page; pass it as `page[after]`. Omitted on the last page.
      - `before` string — Cursor for the previous page; pass it as `page[before]`. Omitted on the first page.
    - `next` string — Relative URL (path and query) of the next page. Omitted when there are no further results.
    - `previous` string — Relative URL (path and query) of the previous page. Omitted on the first page.

## Other responses

- `401` — Unauthorized
- `422` — Unprocessable entity — invalid `page[limit]`, malformed or conflicting cursor, or unsupported `sort` value
- `500` — Internal server error

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api-2.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api-2/revisions/8f5f4e537994/schema)