Sign in
cloudfs filesystems

Get a CloudFS filesystem

Retrieves a CloudFS filesystem by its ID. The returned meta_url omits the credential — the metadata token is only ever returned by create and rotate-meta-token. A filesystem whose last lifecycle action failed includes a customer-safe error message.

get/storage/cloudfs/{id}

Path parameters

idstring uuid required

CloudFS filesystem ID

Response

CloudFS filesystem retrieved successfully

Example response

{
  "data": {
    "created_at": "2026-07-14T21:42:01Z",
    "error": "failed to create storage bucket",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "meta_url": "postgres://fs_0123456789abcdef@us-east-1.telnyxcloudfs.com:5432/fs_0123456789abcdef?sslmode=require",
    "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"
  }
}

Changes

Changed in 4 of the 61 revisions of this API.12311

  • 1571b0380bd793See the full diff
    • ▲

      the response property errors/items/code became optional for the status 401

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 404

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 422

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 401

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 404

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 422

      response-property-became-optional

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 401

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 404

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 422

      response-property-type-changed

    • ○

      added the optional property errors/items/meta/url to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 422 status

      response-optional-property-added

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e537994336See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 401

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 404

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 422

      response-property-type-changed

    • ●

      removed the optional property errors/items/meta/url from the response with the 401 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 404 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 422 status

      response-optional-property-removed

    • ○

      the response property errors/items/code became required for the status 401

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 404

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 422

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 401

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 404

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 422

      response-property-became-required

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • eb02d7e7280b1See the full diff
    • ○

      the endpoint scheme security bearerAuth was removed from the API

      api-security-removed

  • dcc7fe8a21b61See the full diff
    • ○

      endpoint added

      endpoint-added