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

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const CloudfsFilesystemResponseWrapper = await client.storage.cloudfs.create({
  name: 'agent-fs',
  region: 'us-east-1',
});

console.log(CloudfsFilesystemResponseWrapper.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
cloudfs_filesystem_response_wrapper = client.storage.cloudfs.create(
    name="agent-fs",
    region="us-east-1",
)
print(cloudfs_filesystem_response_wrapper.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	cloudf, err := client.Storage.Cloudfs.New(
		context.TODO(),
		telnyx.StorageCloudfsNewParams{,
				Name: telnyx.String("agent-fs"),,
				Region: telnyx.Enumregion,,
			},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", cloudf.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        Params params = Params.builder()
            .name("agent-fs")
            .region(US_EAST_1)
            .build();
        CloudfsFilesystemResponseWrapper response = client.storage()cloudfs()create(params);
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

cloudfs_filesystem_response_wrapper = telnyx.storage.cloudfs.create(name: "agent-fs", region: :"us-east-1")

puts(cloudfs_filesystem_response_wrapper)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $cloudfs_filesystem_response_wrapper = $client->storage->cloudfs->create(
    name: 'agent-fs',
    region: 'us-east-1',
  );

  var_dump($cloudfs_filesystem_response_wrapper);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx storage:cloudfs create \
  --api-key 'My API Key' \
  --name agent-fs \
  --region us-east-1

curl --request POST \
  --url https://api.telnyx.com/v2/storage/cloudfs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "name": "agent-fs",
  "region": "us-east-1"
}
'

{
  "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"
  }
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

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.

Required string length: 1 - 255

Pattern: ^[A-Za-z0-9_-]+$

Body

application/json

CloudFS filesystem creation request

name

string

required

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

Required string length: 1 - 63

Pattern: ^[a-z0-9._-]+$

Example:

"agent-fs"

region

enum<string>

required

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

Available options:

us-central-1,

us-east-1,

us-west-1

Example:

"us-east-1"

Response

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

data

object

A CloudFS filesystem, including its metadata credential. This shape is returned only by create and rotate-meta-token.

Show child attributes

List CloudFS filesystems

Get a CloudFS filesystem

⌘I

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const CloudfsFilesystemResponseWrapper = await client.storage.cloudfs.create({
  name: 'agent-fs',
  region: 'us-east-1',
});

console.log(CloudfsFilesystemResponseWrapper.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
cloudfs_filesystem_response_wrapper = client.storage.cloudfs.create(
    name="agent-fs",
    region="us-east-1",
)
print(cloudfs_filesystem_response_wrapper.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	cloudf, err := client.Storage.Cloudfs.New(
		context.TODO(),
		telnyx.StorageCloudfsNewParams{,
				Name: telnyx.String("agent-fs"),,
				Region: telnyx.Enumregion,,
			},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", cloudf.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        Params params = Params.builder()
            .name("agent-fs")
            .region(US_EAST_1)
            .build();
        CloudfsFilesystemResponseWrapper response = client.storage()cloudfs()create(params);
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

cloudfs_filesystem_response_wrapper = telnyx.storage.cloudfs.create(name: "agent-fs", region: :"us-east-1")

puts(cloudfs_filesystem_response_wrapper)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $cloudfs_filesystem_response_wrapper = $client->storage->cloudfs->create(
    name: 'agent-fs',
    region: 'us-east-1',
  );

  var_dump($cloudfs_filesystem_response_wrapper);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx storage:cloudfs create \
  --api-key 'My API Key' \
  --name agent-fs \
  --region us-east-1

curl --request POST \
  --url https://api.telnyx.com/v2/storage/cloudfs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "name": "agent-fs",
  "region": "us-east-1"
}
'

{
  "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"
  }
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}