Content search
Searches file content with a regular expression, accelerated by the namespace’s grep index. Matches are verified against the real pattern and returned in ascending (inode_id, byte_offset) order; revisions committed after the index watermark are scanned exhaustively unless allow_stale skips them. Requires this deployment to serve grep and the namespace to carry a materialized steady-state grep root.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Namespace id
Request Body required
Section titled “Request Body required ”One content-search request.
object
Permit a capped exhaustive scan when the pattern yields no required grams. Refused beyond the server’s scan budget.
When the unindexed tail exceeds the scan budget, return
indexed-only results (reported via tail_scanned: false) instead
of failing with index_lagging.
Match case-insensitively. Verification is exact; the index remains consulted through its case-folded grams.
Resume cursor from a previous page. The cursor resumes strictly after the last candidate the issuing page finished scanning and is bound to that page’s request; each page is evaluated against the namespace head at page time.
Maximum matches per page.
Regular expression used to search file contents. Backreferences and
lookaround assertions are not supported. Indexed searches require a run
of at least 3 consecutive literal bytes (typically 3 ASCII characters);
otherwise the request returns query_unindexable unless allow_scan is set.
Responses
Section titled “ Responses ”One page of matches
One content-search page.
object
Commits at or below this sequence were answered from the index.
Sequence this page was evaluated at. Pages are evaluated against the namespace head at page time; the cursor is an ordering resume, not a snapshot pin.
Matches in ascending (inode_id, byte_offset) order. A page may
return fewer matches than its limit and still carry a cursor: the
per-page verified-candidate budget bounds how much content one
request reads, whatever the plan’s false-positive rate.
One line-oriented match.
object
The file’s absolute path, derived at the snapshot.
Byte offset of the match within the file.
Durable identity of the matched file.
The matching line, truncated to the server’s line cap.
One-based line number of the match.
True when line was truncated.
The matched revision (the newest visible one at the snapshot).
Namespace searched.
Present when another page follows.
True when revisions after built_through_seq were scanned
exhaustively; false only when allow_stale skipped them.
Invalid pattern, cursor, or an unindexable pattern without allow_scan
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.
The backing store rejected its configured credentials
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 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.
The grep index is corrupt or its backing store is unavailable
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.
This deployment does not serve grep queries, the grep index is not enabled, or its backfill has not completed on this namespace
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.
The index trails the head past the scan budget
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.