List directory
Lists a directory at the current namespace head.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Namespace id
Query Parameters
Section titled “Query Parameters ”Absolute filesystem path
Maximum page size
Opaque directory-list page cursor
Responses
Section titled “ Responses ”Directory listing page
One directory listing and the namespace head it was answered at.
The envelope names the listing target and head so an empty directory
still tells the caller which state it observed, and so the response can
grow without reshaping entries.
object
Absolute path of the listed directory.
Directory entries for this page.
Entries are returned in canonical name-key order. Higher-level display surfaces may sort entries separately for presentation.
Authoritative metadata for one visible path.
This is the result shape for stat/list style reads. File entries include revision and content summary fields; directory entries leave those empty.
object
Absolute path as rendered from stored display names.
Wall-clock stamp of the commit that created the current revision,
for files; directories carry no modification time in v0.
Observational: head_seq and revision sequences are the order.
Current content reference, for files.
object
Immutable identity of the referenced object.
Content strategy used by the referenced object.
Complete byte length of the referenced content.
Mandatory checksum over the complete object, used to verify the stored bytes against this reference without downloading them.
object
Algorithm that produced value.
Lowercase hex of the raw checksum bytes.
The algorithm is its own field, so the value carries no prefix. Provider APIs that report base64 are converted at the adapter.
SHA-256 over the complete payload, lowercase hex, when a trusted party computed it.
Present means the LoonFS write path hashed the whole stream itself, or a provider validated a signed whole-object SHA-256 on the write. There are no client-claimed digests: absent means nobody trustworthy hashed these bytes, never “the client did not tell us”.
Namespace head sequence this answer was read from.
Stable inode identity for this item.
Whether the item is a file or directory.
Namespace that was read.
Current file size in bytes, for files.
Namespace head sequence this listing was read from.
Namespace that was read.
Cursor for the next page, if more entries remain.
Invalid path, limit, or cursor
HTTP error body used by LoonFS APIs.
object
Stable machine-readable reason from the ErrorCode
registry.
Carried as a string so clients keep working when a newer server
introduces a code they do not know; use
ErrorCode::parse for typed access.
Structured context for the code, present when the failure carries machine-usable identity (API spec, “Standard error contract”). Boxed so the rare detailed error does not widen every error-carrying result.
object
Unix milliseconds at which the current epoch’s acquirer took it, when the head recorded one. Writer ids are process labels, so two runs on one machine can share one; the stamp is what tells them apart.
Writer id recorded by the current epoch’s acquirer, when the head recorded one.
Sequence at which that commit id already landed. Present when the failure was decided against a durable commit receipt, which is what holds the sequence; absent when nothing has committed under the id yet and two live requests are simply claiming it at once.
Position, in the request’s operation list, of the operation that failed. A commit applies all of its operations or none of them, so this names the one that stopped the whole request.
For not_supported errors, the capability-document feature key the
client should reconcile against.
Human-readable error message.
Correlation id the server assigned to the failed request; the same
value is sent as the x-request-id response header.
Unauthorized
HTTP error body used by LoonFS APIs.
object
Stable machine-readable reason from the ErrorCode
registry.
Carried as a string so clients keep working when a newer server
introduces a code they do not know; use
ErrorCode::parse for typed access.
Structured context for the code, present when the failure carries machine-usable identity (API spec, “Standard error contract”). Boxed so the rare detailed error does not widen every error-carrying result.
object
Unix milliseconds at which the current epoch’s acquirer took it, when the head recorded one. Writer ids are process labels, so two runs on one machine can share one; the stamp is what tells them apart.
Writer id recorded by the current epoch’s acquirer, when the head recorded one.
Sequence at which that commit id already landed. Present when the failure was decided against a durable commit receipt, which is what holds the sequence; absent when nothing has committed under the id yet and two live requests are simply claiming it at once.
Position, in the request’s operation list, of the operation that failed. A commit applies all of its operations or none of them, so this names the one that stopped the whole request.
For not_supported errors, the capability-document feature key the
client should reconcile against.
Human-readable error message.
Correlation id the server assigned to the failed request; the same
value is sent as the x-request-id response header.
Namespace or path not found
HTTP error body used by LoonFS APIs.
object
Stable machine-readable reason from the ErrorCode
registry.
Carried as a string so clients keep working when a newer server
introduces a code they do not know; use
ErrorCode::parse for typed access.
Structured context for the code, present when the failure carries machine-usable identity (API spec, “Standard error contract”). Boxed so the rare detailed error does not widen every error-carrying result.
object
Unix milliseconds at which the current epoch’s acquirer took it, when the head recorded one. Writer ids are process labels, so two runs on one machine can share one; the stamp is what tells them apart.
Writer id recorded by the current epoch’s acquirer, when the head recorded one.
Sequence at which that commit id already landed. Present when the failure was decided against a durable commit receipt, which is what holds the sequence; absent when nothing has committed under the id yet and two live requests are simply claiming it at once.
Position, in the request’s operation list, of the operation that failed. A commit applies all of its operations or none of them, so this names the one that stopped the whole request.
For not_supported errors, the capability-document feature key the
client should reconcile against.
Human-readable error message.
Correlation id the server assigned to the failed request; the same
value is sent as the x-request-id response header.
Namespace deleted
HTTP error body used by LoonFS APIs.
object
Stable machine-readable reason from the ErrorCode
registry.
Carried as a string so clients keep working when a newer server
introduces a code they do not know; use
ErrorCode::parse for typed access.
Structured context for the code, present when the failure carries machine-usable identity (API spec, “Standard error contract”). Boxed so the rare detailed error does not widen every error-carrying result.
object
Unix milliseconds at which the current epoch’s acquirer took it, when the head recorded one. Writer ids are process labels, so two runs on one machine can share one; the stamp is what tells them apart.
Writer id recorded by the current epoch’s acquirer, when the head recorded one.
Sequence at which that commit id already landed. Present when the failure was decided against a durable commit receipt, which is what holds the sequence; absent when nothing has committed under the id yet and two live requests are simply claiming it at once.
Position, in the request’s operation list, of the operation that failed. A commit applies all of its operations or none of them, so this names the one that stopped the whole request.
For not_supported errors, the capability-document feature key the
client should reconcile against.
Human-readable error message.
Correlation id the server assigned to the failed request; the same
value is sent as the x-request-id response header.