Skip to main content
POST
/
filesystems
Create Filesystem
curl --request POST \
  --url https://api.example.com/filesystems \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "name": "<string>"
}
'
{
  "id": "<string>",
  "namespace_id": "<string>",
  "archive_checksum": "<string>",
  "archive_path": "<string>",
  "archive_size_bytes": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "last_synced_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "project_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}
Filesystems are linked to a project and inherit permissions from that project.

​
CLI Usage

CLI
tu fs create --project-id proj-123

# With optional name and directory to push
tu fs create -p proj-123 --name my-workspace --dir ./local-files

# JSON output
tu fs create -p proj-123 -j

Body

application/json

Request model for creating a filesystem.

Filesystems inherit permissions from their parent project.

​
project_id
string
required

Project ID. Filesystem inherits permissions from the project.

​
name
string | null

Optional human-readable name for the filesystem (unique per namespace).

Response

Successful Response

Response model for filesystem operations.

​
id
string
required

The unique identifier of the filesystem.

​
namespace_id
string
required

The namespace this filesystem belongs to.

​
status
enum<string>
required

The current status of the filesystem.

Available options:
CREATING,
READY,
SYNCING_UP,
SYNCING_DOWN,
FAILED
​
archive_checksum
string | null

SHA256 checksum of the archive for detecting changes.

​
archive_path
string | null

GCS path for the filesystem's archive.

​
archive_size_bytes
integer | null

Size of the archive in bytes after last sync.

​
created_at
string<date-time> | null

The timestamp when the filesystem was created.

​
last_synced_at
string<date-time> | null

Timestamp of the last successful sync operation.

​
name
string | null

Optional human-readable name (unique per namespace).

​
project_id
string | null

The project this filesystem belongs to (optional).

​
updated_at
string<date-time> | null

The timestamp when the filesystem was last updated.