List files on a lease

Lists one directory in the lease.

Checked 2026-09-28

Lists one directory in the lease.

Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/leases/lease:listFiles
Scope sandboxes:exec
Effect read — nothing is written.
Collection leases

#Request

Field	Type	What it is
`name`	`string`	The name of the lease. Required.
`path`	`string`	The absolute directory path in the guest. Required.
`depth`	`int32`	Descend this many levels; default 1.

#Response

Field	Type	What it is
`entries`	`FileEntry[]`	The entries.

#FileEntry

Field	Type	What it is
`path`	`string`	The absolute path.
`directory`	`bool`	Whether it is a directory.
`size_bytes`	`int64`	Size in bytes.
`mode`	`int32`	The mode bits.
`modify_time`	`timestamp`	When it last changed.

#Errors

UNAUTHENTICATED — No valid key or token was presented.
PERMISSION_DENIED — The key lacks the method's permission.
RESOURCE_NOT_FOUND — The named Resource does not exist or is not visible.
NOT_FOUND — No method is served at this path.
INVALID_STATE — The Resource is in a state that forbids the call.

Every error arrives in the body Errors describes.

#Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/leases/lease:listFiles" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"path":"…"}'

Was this page helpful?

Tell us what is missing, wrong, or unclear — this opens a real inbox.

Send feedback

Platform links