cloudfs filesystems

Create a CloudFS filesystem

Changed on

Creates a CloudFS filesystem. Provisioning is synchronous — typically a few seconds, up to a few minutes — and the filesystem is returned with status ready, together with its S3 bucket and metadata connection details. This response is the only time the filesystem's meta_token — and the credential-bearing meta_url — are returned; store them securely. If the token is lost, issue a new one with the rotate-meta-token action. Names are unique within your organization: creating with an existing name returns a 422. Requests are idempotent: retrying with the same Idempotency-Key within 24 hours replays the original response instead of creating another filesystem.

post/storage/cloudfs

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/storage/cloudfs
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Unique key that makes the request idempotent (1-255 characters: letters, numbers, _, and -). Retrying with the same key within 24 hours replays the original response (marked with an Idempotent-Replayed: true header) instead of repeating the action. Reusing a key with a different request returns a 422; sending a key while the original request is still being processed returns a 409.

Request body

namestring required

Filesystem name, unique within your organization. Names are trimmed and lowercased; after normalization they may contain lowercase letters, numbers, ., _, and - only.

region'us-central-1' | 'us-east-1' | 'us-west-1' required

Region where the filesystem's storage and metadata are provisioned.

Example request

{
  "name": "agent-fs",
  "region": "us-east-1"
}

Response

CloudFS filesystem created successfully. This is the only response (besides rotate-meta-token) that includes meta_token.

Example response

{
  "data": {
    "record_type": "cloudfs",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "agent-fs",
    "status": "ready",
    "meta_url": "postgres://fs_0123456789abcdef@us-east-1.telnyxcloudfs.com:5432/fs_0123456789abcdef?sslmode=require",
    "meta_token": "cloudfs_tok_0123456789abcdef0123456789abcdef",
    "s3_endpoint": "https://us-east-1.telnyxcloudstorage.com",
    "s3_bucket": "cloudfs-fs-0123456789abcdef",
    "region": "us-east-1",
    "created_at": "2026-07-14T21:42:01Z",
    "updated_at": "2026-07-14T21:42:01Z"
  }
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status