Skip to Content
Podyard

FILESYSTEM

Read, write, and delete files inside a pod's virtual filesystem.

FILESYSTEM_FS

The FS endpoints operate on a pod's virtual filesystem. Paths are absolute (/workspace/script.py).

Note: Directory listing (GET on a directory path) is not yet supported by the engine. Podyard returns 501 not_implemented for directory listing and labels it Coming soon.


GET /v1/pods/{id}/fs/{path} — Read a file

Returns the file contents.

Query params:

ParamTypeDescription
encodingutf8 | base64Response encoding. Defaults to utf8; use base64 for binary files.

Response 200 (utf8):

{ "path": "/workspace/script.py", "content": "print('hello')\n" }

Response 200 (base64):

{ "path": "/workspace/blob.bin", "content": "Zm9vYmFy", "encoding": "base64" }

Errors: 404 not_found (file not found), 413 payload_too_large (file exceeds plan's maxFileSizeBytes), 422 invalid_request (path is a directory → directory listing not implemented).


PUT /v1/pods/{id}/fs/{path} — Write a file

Creates or overwrites a file. Parent directories are created automatically.

Body:

{
  "content": "print('hello')",
  "encoding": "utf8"
}
FieldTypeRequiredDescription
contentstringyesFile contents
encodingutf8 | base64noDefaults to utf8

Response 200:

{ "path": "/workspace/script.py", "sizeBytes": 14 }

Errors: 413 payload_too_large (content exceeds maxFileSizeBytes), 422 invalid_request.


DELETE /v1/pods/{id}/fs/{path} — Delete a file

Response 204: empty body.

Errors: 404 not_found.


SIZE_LIMITS

All FS operations are subject to the plan's maxFileSizeBytes and maxPodVfsBytes limits. See Limits.

WHERE_TO_GO_NEXT

  • Pods — pod lifecycle.
  • Exec — run commands.
  • Errors — full error code reference.