List directory
Lists a directory from the current state or a live snapshot.
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
Project each entry’s attribute map and revision (true or false). Defaults to false: a page holds many entries and each map may be 64 KiB, so a listing does not carry them unless asked.
Durable pin identifier. The manifest number determines which namespace manifest it pins.
Example
pin_00000000000000000001-0000000000000002Use the directory state captured by this snapshot
Responses
Section titled “ Responses ”Directory listing page
One directory listing and the namespace head used to read it.
object
The directory entries in canonical name-key order.
A directory without a revision payload.
object
The complete attribute map at attributes_revision_no, including an empty map for the initial state.
object
A validated inode attribute value of at most 4,096 UTF-8 bytes.
Empty strings and control characters are valid, and only an explicit remove operation deletes an attribute.
Example
platformThe attribute revision this projection represents.
The latest attribute update time in Unix milliseconds, absent for the initial empty state.
The actor responsible for the latest attribute update, absent for the initial empty state.
Example
usr_8f3cThe opaque ID for the current parent and name binding, absent for the namespace root.
The inode creation time in Unix milliseconds.
Actor that created this inode, as supplied by the application.
Example
usr_8f3cStored display name for this path component, absent for the nameless root.
Example
report.txtNamespace head sequence this answer was read from.
Stable inode identity for this item.
Example
ino_123Whether the entry is a file or a directory.
Namespace that was read.
Example
demoParent directory inode, absent for the root.
Example
ino_123Absolute path as rendered from stored display names.
Example
/docs/report.txtA file and its current revision summary.
object
The complete attribute map at attributes_revision_no, including an empty map for the initial state.
object
A validated inode attribute value of at most 4,096 UTF-8 bytes.
Empty strings and control characters are valid, and only an explicit remove operation deletes an attribute.
Example
platformThe attribute revision this projection represents.
The latest attribute update time in Unix milliseconds, absent for the initial empty state.
The actor responsible for the latest attribute update, absent for the initial empty state.
Example
usr_8f3cThe opaque ID for the current parent and name binding, absent for the namespace root.
Current content reference.
object
Mandatory checksum over the complete object.
object
Algorithm that produced value.
The canonical lowercase hexadecimal checksum without a prefix.
Immutable identity of the content; with the owner, it determines the object key.
Example
con_9f2a6c0e4b7d4a90b13f0d8c5e6a2b41Content strategy used by the referenced content.
Namespace that originally wrote the bytes.
Example
demoComplete byte length of the referenced content.
The inode creation time in Unix milliseconds.
Actor that created this inode, as supplied by the application.
Example
usr_8f3cStored display name for this path component, absent for the nameless root.
Example
report.txtNamespace head sequence this answer was read from.
Stable inode identity for this item.
Example
ino_123Whether the entry is a file or a directory.
Namespace that was read.
Example
demoParent directory inode, absent for the root.
Example
ino_123Absolute path as rendered from stored display names.
Example
/docs/report.txtThe current revision time in Unix milliseconds.
Actor responsible for the current revision.
Example
usr_8f3cCurrent file revision number.
The current file size in bytes.
Namespace head sequence this listing was read from.
Namespace that was read.
Example
demoCursor for the next page, if more entries remain.
Absolute path of the listed directory.
Example
/docs/report.txtInvalid path, limit, cursor, include_attributes, snapshot id, or non-snapshot checkpoint
HTTP error body used by LoonFS APIs.
object
The stable machine-readable error code as a string.
The optional machine-readable context for the error code.
object
The Unix-millisecond time when the current writer acquired its epoch, when available.
Epoch that currently owns the namespace.
The writer ID recorded for the current epoch, when available.
Access revision that is actually current for the inode.
Attribute revision that is actually current for the inode.
Current binding token; absent for the root, which has no binding.
Deletion sequence actually active for the inode.
The actual namespace head sequence.
The path actually contained this inode.
Example
ino_123Revision that is actually current; absent when the inode has none.
Change-feed cursor the request asked to resume after.
Idempotency key of the commit the error concerns.
Example
c_f3a9c2d4b6e8417a90c5d2f8e1b7a6c0The fingerprint of the mutation that landed under commit_id, present with committed_seq.
The sequence where this commit ID already landed, when recorded by a durable receipt.
Access revision the request expected to be current.
Attribute revision the request expected to be current.
Opaque binding token supplied by the request.
Deletion sequence the undelete expected to be active.
The head sequence required by the request.
The request expected the path to contain this inode.
Example
ino_123Revision the request expected to be current.
Epoch the failing writer session held when it was displaced.
Inode the failed precondition or operation targeted.
Example
ino_123Maximum writer sessions admitted by the node.
The deleted namespace that caused the operation to fail.
Example
demoThe index of the failed operation in the request.
Zero-based position of the failed request precondition.
Oldest sequence still promised for incremental replay.
The capability feature key for a not_supported error.
Human-readable error message.
The invalid JSON Pointer, parameter name, CLI flag, or CLI argument.
The request correlation ID also sent in the x-request-id response header.
Unauthorized
HTTP error body used by LoonFS APIs.
object
The stable machine-readable error code as a string.
The optional machine-readable context for the error code.
object
The Unix-millisecond time when the current writer acquired its epoch, when available.
Epoch that currently owns the namespace.
The writer ID recorded for the current epoch, when available.
Access revision that is actually current for the inode.
Attribute revision that is actually current for the inode.
Current binding token; absent for the root, which has no binding.
Deletion sequence actually active for the inode.
The actual namespace head sequence.
The path actually contained this inode.
Example
ino_123Revision that is actually current; absent when the inode has none.
Change-feed cursor the request asked to resume after.
Idempotency key of the commit the error concerns.
Example
c_f3a9c2d4b6e8417a90c5d2f8e1b7a6c0The fingerprint of the mutation that landed under commit_id, present with committed_seq.
The sequence where this commit ID already landed, when recorded by a durable receipt.
Access revision the request expected to be current.
Attribute revision the request expected to be current.
Opaque binding token supplied by the request.
Deletion sequence the undelete expected to be active.
The head sequence required by the request.
The request expected the path to contain this inode.
Example
ino_123Revision the request expected to be current.
Epoch the failing writer session held when it was displaced.
Inode the failed precondition or operation targeted.
Example
ino_123Maximum writer sessions admitted by the node.
The deleted namespace that caused the operation to fail.
Example
demoThe index of the failed operation in the request.
Zero-based position of the failed request precondition.
Oldest sequence still promised for incremental replay.
The capability feature key for a not_supported error.
Human-readable error message.
The invalid JSON Pointer, parameter name, CLI flag, or CLI argument.
The request correlation ID also sent in the x-request-id response header.
Namespace, path, or snapshot not found
HTTP error body used by LoonFS APIs.
object
The stable machine-readable error code as a string.
The optional machine-readable context for the error code.
object
The Unix-millisecond time when the current writer acquired its epoch, when available.
Epoch that currently owns the namespace.
The writer ID recorded for the current epoch, when available.
Access revision that is actually current for the inode.
Attribute revision that is actually current for the inode.
Current binding token; absent for the root, which has no binding.
Deletion sequence actually active for the inode.
The actual namespace head sequence.
The path actually contained this inode.
Example
ino_123Revision that is actually current; absent when the inode has none.
Change-feed cursor the request asked to resume after.
Idempotency key of the commit the error concerns.
Example
c_f3a9c2d4b6e8417a90c5d2f8e1b7a6c0The fingerprint of the mutation that landed under commit_id, present with committed_seq.
The sequence where this commit ID already landed, when recorded by a durable receipt.
Access revision the request expected to be current.
Attribute revision the request expected to be current.
Opaque binding token supplied by the request.
Deletion sequence the undelete expected to be active.
The head sequence required by the request.
The request expected the path to contain this inode.
Example
ino_123Revision the request expected to be current.
Epoch the failing writer session held when it was displaced.
Inode the failed precondition or operation targeted.
Example
ino_123Maximum writer sessions admitted by the node.
The deleted namespace that caused the operation to fail.
Example
demoThe index of the failed operation in the request.
Zero-based position of the failed request precondition.
Oldest sequence still promised for incremental replay.
The capability feature key for a not_supported error.
Human-readable error message.
The invalid JSON Pointer, parameter name, CLI flag, or CLI argument.
The request correlation ID also sent in the x-request-id response header.
Namespace deleted or snapshot deleted or expired
HTTP error body used by LoonFS APIs.
object
The stable machine-readable error code as a string.
The optional machine-readable context for the error code.
object
The Unix-millisecond time when the current writer acquired its epoch, when available.
Epoch that currently owns the namespace.
The writer ID recorded for the current epoch, when available.
Access revision that is actually current for the inode.
Attribute revision that is actually current for the inode.
Current binding token; absent for the root, which has no binding.
Deletion sequence actually active for the inode.
The actual namespace head sequence.
The path actually contained this inode.
Example
ino_123Revision that is actually current; absent when the inode has none.
Change-feed cursor the request asked to resume after.
Idempotency key of the commit the error concerns.
Example
c_f3a9c2d4b6e8417a90c5d2f8e1b7a6c0The fingerprint of the mutation that landed under commit_id, present with committed_seq.
The sequence where this commit ID already landed, when recorded by a durable receipt.
Access revision the request expected to be current.
Attribute revision the request expected to be current.
Opaque binding token supplied by the request.
Deletion sequence the undelete expected to be active.
The head sequence required by the request.
The request expected the path to contain this inode.
Example
ino_123Revision the request expected to be current.
Epoch the failing writer session held when it was displaced.
Inode the failed precondition or operation targeted.
Example
ino_123Maximum writer sessions admitted by the node.
The deleted namespace that caused the operation to fail.
Example
demoThe index of the failed operation in the request.
Zero-based position of the failed request precondition.
Oldest sequence still promised for incremental replay.
The capability feature key for a not_supported error.
Human-readable error message.
The invalid JSON Pointer, parameter name, CLI flag, or CLI argument.
The request correlation ID also sent in the x-request-id response header.
The server cannot complete the request now. Inspect code to determine whether the cause is a deadline, shutdown, load, writer-session admission, required maintenance, or invalid storage credentials. A mutation may still complete after a deadline or lost acknowledgment, so determine its outcome before retrying.
HTTP error body used by LoonFS APIs.
object
The stable machine-readable error code as a string.
The optional machine-readable context for the error code.
object
The Unix-millisecond time when the current writer acquired its epoch, when available.
Epoch that currently owns the namespace.
The writer ID recorded for the current epoch, when available.
Access revision that is actually current for the inode.
Attribute revision that is actually current for the inode.
Current binding token; absent for the root, which has no binding.
Deletion sequence actually active for the inode.
The actual namespace head sequence.
The path actually contained this inode.
Example
ino_123Revision that is actually current; absent when the inode has none.
Change-feed cursor the request asked to resume after.
Idempotency key of the commit the error concerns.
Example
c_f3a9c2d4b6e8417a90c5d2f8e1b7a6c0The fingerprint of the mutation that landed under commit_id, present with committed_seq.
The sequence where this commit ID already landed, when recorded by a durable receipt.
Access revision the request expected to be current.
Attribute revision the request expected to be current.
Opaque binding token supplied by the request.
Deletion sequence the undelete expected to be active.
The head sequence required by the request.
The request expected the path to contain this inode.
Example
ino_123Revision the request expected to be current.
Epoch the failing writer session held when it was displaced.
Inode the failed precondition or operation targeted.
Example
ino_123Maximum writer sessions admitted by the node.
The deleted namespace that caused the operation to fail.
Example
demoThe index of the failed operation in the request.
Zero-based position of the failed request precondition.
Oldest sequence still promised for incremental replay.
The capability feature key for a not_supported error.
Human-readable error message.
The invalid JSON Pointer, parameter name, CLI flag, or CLI argument.
The request correlation ID also sent in the x-request-id response header.