Sign in
cloudfs filesystems

Create a CloudFS filesystem

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

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": {
    "created_at": "2026-07-14T21:42:01Z",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "meta_token": "cloudfs_tok_0123456789abcdef0123456789abcdef",
    "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.16414

  • 1571b0380bd7124See the full diff
    • ▲

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

      response-property-became-optional

    • ▲

      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 409

      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 400

      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 409

      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 400

      response-property-type-changed

    • ▲

      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 409

      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 400 status

      response-optional-property-added

    • ○

      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 409 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

  • 8f5f4e537994448See the full diff
    • ▲

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

      response-property-type-changed

    • ▲

      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 409

      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 400 status

      response-optional-property-removed

    • ●

      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 409 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 400

      response-property-became-required

    • ○

      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 409

      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 400

      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 409

      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