VirtualFileSystem

A virtual file system (VFS): a named folder tree in a namespace. Capsules and code pipelines mount it as a directory, apps and agents read and write it, and you can fill it through the API.

Kind: an object, used in responses.

Fields

Every field is present in a response; empty ones are null.

Field	Type	Description
name	string	The file system’s name.
mounts	VirtualFileSystemMount[]	The runs it is mounted into right now. A file system cannot be destroyed while it is mounted.
status	VirtualFileSystemStatus	Whether it is active or being destroyed.
dateDestroyed	datetime | null	When destroying it began (UTC). Null while it is active.
userCreatedById	uuid	The id of the user who created it. A call made with an API key is recorded as the key’s user.
namespaceId	uuid	The id of the namespace it belongs to.
tenantId	uuid	The id of the tenant it belongs to.
id	uuid	The unique id. Use it in by-id routes and wherever another object refers to this one.
dateCreated	datetime	When it was created, in UTC.
dateUpdated	datetime	When it was last changed, in UTC.

Example

{
  "name": "...",
  "mounts": [
    {
      "type": "CapsuleProcess",
      "associatedId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
      "location": "...",
      "mountTime": "2026-10-26T12:00:00.0000000Z"
    }
  ],
  "status": "Active",
  "dateDestroyed": "2026-10-26T12:00:00.0000000Z",
  "userCreatedById": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "namespaceId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "tenantId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "dateCreated": "2026-10-26T12:00:00.0000000Z",
  "dateUpdated": "2026-10-26T12:00:00.0000000Z"
}

Where it’s used

• vfs.create (POST /namespaces/{namespaceName}/vfs)
• vfs.getByName (GET /namespaces/{namespaceName}/vfs/by-name/{name})
• vfs.get (GET /vfs/by-id/{id})
• vfs.list (GET /namespaces/{namespaceName}/vfs)
• vfs.list (GET /vfs)