Sign in

v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
cloudfs filesystems

List CloudFS filesystems

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.

get/storage/cloudfs

Query parameters

page[limit]integer

The number of filesystems to return per page. Values above 250 are treated as 250.

page[after]string

Opaque cursor from a previous response's meta.cursors.after; returns the page after it. Mutually exclusive with page[before].

page[before]string

Opaque cursor from a previous response's meta.cursors.before; returns the page before it. Mutually exclusive with page[after].

filter[name]string

Return only the filesystem whose name matches exactly.

filter[status]'provisioning' | 'ready' | 'needs_format' | 'deleting' | 'failed'

Return only filesystems with this status. Unrecognized values are ignored.

filter[region]string
Example:us-east-1

Return only filesystems in this region.

sort'created_at' | '-created_at' | 'updated_at' | '-updated_at' | 'name' | '-name'

Sort order for the results: a field name for ascending, or the field name prefixed with - for descending.

Response

CloudFS filesystems retrieved successfully

Example response

{
  "data": [
    {
      "created_at": "2026-07-14T21:42:01Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "agent-fs",
      "record_type": "cloudfs",
      "region": "us-east-1",
      "s3_bucket": "cloudfs-fs-0123456789abcdef",
      "s3_endpoint": "https://us-east-1.telnyxcloudstorage.com",
      "status": "ready",
      "updated_at": "2026-07-14T21:42:01Z"
    }
  ]
}