Skip to content

Filesystem API ​

Transport ​

AgentBox exposes this service through the Connect protocol over HTTP. The AgentBox SDK supplies the routing and authorization headers automatically.

  • Production base URL: https://sandbox.agentbox-runtime.ru
  • Fully qualified service: filesystem.Filesystem
  • RPC URL pattern: POST https://sandbox.agentbox-runtime.ru/filesystem.Filesystem/{RPC}

Request headers ​

  • Agentbox-Sandbox-Id · required — Sandbox identifier.
  • Agentbox-Sandbox-Port · required — Envd port routed by the sandbox proxy. Default: 49983.
  • X-Access-Token · conditional — Sandbox-scoped envd access token, when one was issued.

Stat ​

Public RPC exposed by envd.

  • Endpoint: POST https://sandbox.agentbox-runtime.ru/filesystem.Filesystem/Stat
  • Request: StatRequest
  • Response: StatResponse

MakeDir ​

Public RPC exposed by envd.

  • Endpoint: POST https://sandbox.agentbox-runtime.ru/filesystem.Filesystem/MakeDir
  • Request: MakeDirRequest
  • Response: MakeDirResponse

Move ​

Public RPC exposed by envd.

  • Endpoint: POST https://sandbox.agentbox-runtime.ru/filesystem.Filesystem/Move
  • Request: MoveRequest
  • Response: MoveResponse

ListDir ​

Public RPC exposed by envd.

  • Endpoint: POST https://sandbox.agentbox-runtime.ru/filesystem.Filesystem/ListDir
  • Request: ListDirRequest
  • Response: ListDirResponse

Remove ​

Public RPC exposed by envd.

  • Endpoint: POST https://sandbox.agentbox-runtime.ru/filesystem.Filesystem/Remove
  • Request: RemoveRequest
  • Response: RemoveResponse

WatchDir ​

Public RPC exposed by envd.

  • Endpoint: POST https://sandbox.agentbox-runtime.ru/filesystem.Filesystem/WatchDir
  • Request: WatchDirRequest
  • Response: stream WatchDirResponse

CreateWatcher ​

Non-streaming versions of WatchDir

  • Endpoint: POST https://sandbox.agentbox-runtime.ru/filesystem.Filesystem/CreateWatcher
  • Request: CreateWatcherRequest
  • Response: CreateWatcherResponse

GetWatcherEvents ​

Public RPC exposed by envd.

  • Endpoint: POST https://sandbox.agentbox-runtime.ru/filesystem.Filesystem/GetWatcherEvents
  • Request: GetWatcherEventsRequest
  • Response: GetWatcherEventsResponse

RemoveWatcher ​

Public RPC exposed by envd.

  • Endpoint: POST https://sandbox.agentbox-runtime.ru/filesystem.Filesystem/RemoveWatcher
  • Request: RemoveWatcherRequest
  • Response: RemoveWatcherResponse

Message types ​

MoveRequest ​

FieldTypeNumberDescription
sourcestring1
destinationstring2

MoveResponse ​

FieldTypeNumberDescription
entryEntryInfo1

MakeDirRequest ​

FieldTypeNumberDescription
pathstring1

MakeDirResponse ​

FieldTypeNumberDescription
entryEntryInfo1

RemoveRequest ​

FieldTypeNumberDescription
pathstring1

RemoveResponse ​

StatRequest ​

FieldTypeNumberDescription
pathstring1

StatResponse ​

FieldTypeNumberDescription
entryEntryInfo1

EntryInfo ​

FieldTypeNumberDescription
namestring1
typeFileType2
pathstring3
sizeint644
modeuint325
permissionsstring6
ownerstring7
groupstring8
modified_timegoogle.protobuf.Timestamp9
symlink_targetoptional string10If the entry is a symlink, this field contains the target of the symlink.
metadatamap<string, string>11User-defined metadata stored as extended attributes (xattrs) on the file. Keys live under the user.agentbox. xattr namespace; the prefix is stripped here. Plain user.* xattrs written by other tooling are not reflected.

ListDirRequest ​

FieldTypeNumberDescription
pathstring1
depthuint322

ListDirResponse ​

FieldTypeNumberDescription
entriesrepeated EntryInfo1

WatchDirRequest ​

FieldTypeNumberDescription
pathstring1
recursivebool2
include_entrybool3If true, each FilesystemEvent includes the EntryInfo of the affected entry, when available.
allow_network_mountsbool4If true, allows watching paths on network filesystem mounts (NFS, CIFS, SMB, FUSE). Events on network mounts may be unreliable or not delivered at all.

FilesystemEvent ​

FieldTypeNumberDescription
namestring1
typeEventType2
entryoptional EntryInfo3Info of the entry that triggered the event. Only populated when include_entry was requested and the entry could be stat-ed (e.g. not set for remove/rename-away events, where the entry no longer exists at this path).

WatchDirResponse ​

FieldTypeNumberOneofDescription
startStartEvent1event
filesystemFilesystemEvent2event
keepaliveKeepAlive3event

WatchDirResponse.StartEvent ​

WatchDirResponse.KeepAlive ​

CreateWatcherRequest ​

FieldTypeNumberDescription
pathstring1
recursivebool2
include_entrybool3If true, each FilesystemEvent includes the EntryInfo of the affected entry, when available.
allow_network_mountsbool4If true, allows watching paths on network filesystem mounts (NFS, CIFS, SMB, FUSE). Events on network mounts may be unreliable or not delivered at all.

CreateWatcherResponse ​

FieldTypeNumberDescription
watcher_idstring1

GetWatcherEventsRequest ​

FieldTypeNumberDescription
watcher_idstring1

GetWatcherEventsResponse ​

FieldTypeNumberDescription
eventsrepeated FilesystemEvent1

RemoveWatcherRequest ​

FieldTypeNumberDescription
watcher_idstring1

RemoveWatcherResponse ​

Enum types ​

FileType ​

ValueNumberDescription
FILE_TYPE_UNSPECIFIED0
FILE_TYPE_FILE1
FILE_TYPE_DIRECTORY2
FILE_TYPE_SYMLINK3

EventType ​

ValueNumberDescription
EVENT_TYPE_UNSPECIFIED0
EVENT_TYPE_CREATE1
EVENT_TYPE_WRITE2
EVENT_TYPE_REMOVE3
EVENT_TYPE_RENAME4
EVENT_TYPE_CHMOD5