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.
Headers
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
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"
}
}