Begin download
Authorizes one direct read of a file’s content object and returns a short-lived presigned GET capability, the resolved revision, and the content reference the client checks the arriving bytes against. Range is outside the signature, so one grant serves ranged, resumed, and parallel reads. Deployments that cannot presign answer 501 not_supported; the proxied GET /filesystem/content route stays available and is capped by download.service_proxied.max_content_bytes.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Namespace id
Request Body required
Section titled “Request Body required ”The path to download and, optionally, the revision to download.
object
Absolute path of the file to read.
Example
/docs/report.txtRevision to read. Omit it for the path’s current revision. Cannot be combined with snapshot_id.
Read the file revision captured by this snapshot. Cannot be combined with revision_no.
Example
pin_00000000000000000001-0000000000000002Responses
Section titled “ Responses ”Download authorized
A presigned URL for one content object.
The URL expires at access.expires_at_ms; later path changes do not change the object.
object
Short-lived URL plus required headers for one object-store write.
object
Expiration timestamp in Unix milliseconds.
Headers that are covered by the signature and must be sent.
object
HTTP method the client must use.
Full presigned URL.
The identity, byte length, and checksum of the object to download.
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.
Namespace that was read.
Example
demoAbsolute path as rendered from stored display names.
Example
/docs/report.txtRevision the capability reads, resolved from the request.
Invalid path, revision, snapshot id, non-snapshot checkpoint, or revision_no combined with snapshot_id
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, revision, 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.
JSON body exceeds the 2 MiB limit
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.
Direct download is unsupported
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.