List snapshots

GET

/v0/namespaces/{namespace_id}/snapshots

Lists live snapshots in snapshot-id order. Deleted and expired snapshots are omitted.

Authorizations

• bearer_auth

Parameters

Path Parameters

namespace_id

required

string

Namespace id

Query Parameters

limit

integer format: int32

default: 1000 >= 1 <= 1000

Maximum page size

cursor

string

Opaque snapshot-list page cursor

Responses

200

Live snapshots

One page of live read snapshots.

object

namespace_id

required

Namespace the snapshots belong to.

string

/^[a-z0-9][a-z0-9._-]{0,127}$/

Example

demo

next_cursor

Opaque cursor for the next page.

string

snapshots

required

Live snapshot records in ascending snapshot-id order.

Array<object>

A live snapshot.

object

captured_seq

required

Namespace sequence captured by the snapshot.

integer format: int64

<= 9007199254740991

created_at_ms

required

Time the snapshot record was created, in Unix milliseconds.

integer format: int64

expires_at_ms

required

When the snapshot expires, in Unix milliseconds.

integer format: int64

name

required

Snapshot label.

string

namespace_id

required

Namespace whose state the snapshot captured.

string

/^[a-z0-9][a-z0-9._-]{0,127}$/

Example

demo

snapshot_id

required

Snapshot id.

string

/^pin_[0-9]{20}-[0-9a-f]{16}$/

Example

pin_00000000000000000001-0000000000000002

400

Invalid namespace id, limit, or cursor

HTTP error body used by LoonFS APIs.

object

code

required

The stable machine-readable error code as a string.

string

details

The optional machine-readable context for the error code.

object

active_acquired_at_ms

The Unix-millisecond time when the current writer acquired its epoch, when available.

integer format: int64

active_writer_epoch

Epoch that currently owns the namespace.

integer format: int64

<= 9007199254740991

active_writer_id

The writer ID recorded for the current epoch, when available.

string

actual_access_revision_no

Access revision that is actually current for the inode.

integer format: int64

<= 9007199254740991

actual_attributes_revision_no

Attribute revision that is actually current for the inode.

integer format: int64

<= 9007199254740991

actual_binding_version

Current binding token; absent for the root, which has no binding.

string

/^[0-9a-f]+$/

actual_deletion_seq

Deletion sequence actually active for the inode.

integer format: int64

<= 9007199254740991

actual_head_seq

The actual namespace head sequence.

integer format: int64

<= 9007199254740991

actual_inode_id

The path actually contained this inode.

string

/^ino_[1-9][0-9]*$/

Example

ino_123

actual_revision_no

Revision that is actually current; absent when the inode has none.

integer format: int64

<= 9007199254740991

after_seq

Change-feed cursor the request asked to resume after.

integer format: int64

<= 9007199254740991

commit_id

Idempotency key of the commit the error concerns.

string

/^[a-z0-9][a-z0-9._-]{0,127}$/

Example

c_f3a9c2d4b6e8417a90c5d2f8e1b7a6c0

committed_fingerprint

The fingerprint of the mutation that landed under commit_id, present with committed_seq.

string

committed_seq

The sequence where this commit ID already landed, when recorded by a durable receipt.

integer format: int64

<= 9007199254740991

expected_access_revision_no

Access revision the request expected to be current.

integer format: int64

<= 9007199254740991

expected_attributes_revision_no

Attribute revision the request expected to be current.

integer format: int64

<= 9007199254740991

expected_binding_version

Opaque binding token supplied by the request.

string

/^[0-9a-f]+$/

expected_deletion_seq

Deletion sequence the undelete expected to be active.

integer format: int64

<= 9007199254740991

expected_head_seq

The head sequence required by the request.

integer format: int64

<= 9007199254740991

expected_inode_id

The request expected the path to contain this inode.

string

/^ino_[1-9][0-9]*$/

Example

ino_123

expected_revision_no

Revision the request expected to be current.

integer format: int64

<= 9007199254740991

fenced_writer_epoch

Epoch the failing writer session held when it was displaced.

integer format: int64

<= 9007199254740991

inode_id

Inode the failed precondition or operation targeted.

string

/^ino_[1-9][0-9]*$/

Example

ino_123

max_writer_sessions

Maximum writer sessions admitted by the node.

integer

namespace_id

The deleted namespace that caused the operation to fail.

string

/^[a-z0-9][a-z0-9._-]{0,127}$/

Example

demo

operation_index

The index of the failed operation in the request.

integer format: int32

precondition_index

Zero-based position of the failed request precondition.

integer format: int32

retention_floor_seq

Oldest sequence still promised for incremental replay.

integer format: int64

<= 9007199254740991

feature

The capability feature key for a not_supported error.

string

message

required

Human-readable error message.

string

param

The invalid JSON Pointer, parameter name, CLI flag, or CLI argument.

string

request_id

The request correlation ID also sent in the x-request-id response header.

string

401

Unauthorized

HTTP error body used by LoonFS APIs.

object

code

required

The stable machine-readable error code as a string.

string

details

The optional machine-readable context for the error code.

object

active_acquired_at_ms

The Unix-millisecond time when the current writer acquired its epoch, when available.

integer format: int64

active_writer_epoch

Epoch that currently owns the namespace.

integer format: int64

<= 9007199254740991

active_writer_id

The writer ID recorded for the current epoch, when available.

string

actual_access_revision_no

Access revision that is actually current for the inode.

integer format: int64

<= 9007199254740991

actual_attributes_revision_no

Attribute revision that is actually current for the inode.

integer format: int64

<= 9007199254740991

actual_binding_version

Current binding token; absent for the root, which has no binding.

string

/^[0-9a-f]+$/

actual_deletion_seq

Deletion sequence actually active for the inode.

integer format: int64

<= 9007199254740991

actual_head_seq

The actual namespace head sequence.

integer format: int64

<= 9007199254740991

actual_inode_id

The path actually contained this inode.

string

/^ino_[1-9][0-9]*$/

Example

ino_123

actual_revision_no

Revision that is actually current; absent when the inode has none.

integer format: int64

<= 9007199254740991

after_seq

Change-feed cursor the request asked to resume after.

integer format: int64

<= 9007199254740991

commit_id

Idempotency key of the commit the error concerns.

string

/^[a-z0-9][a-z0-9._-]{0,127}$/

Example

c_f3a9c2d4b6e8417a90c5d2f8e1b7a6c0

committed_fingerprint

The fingerprint of the mutation that landed under commit_id, present with committed_seq.

string

committed_seq

The sequence where this commit ID already landed, when recorded by a durable receipt.

integer format: int64

<= 9007199254740991

expected_access_revision_no

Access revision the request expected to be current.

integer format: int64

<= 9007199254740991

expected_attributes_revision_no

Attribute revision the request expected to be current.

integer format: int64

<= 9007199254740991

expected_binding_version

Opaque binding token supplied by the request.

string

/^[0-9a-f]+$/

expected_deletion_seq

Deletion sequence the undelete expected to be active.

integer format: int64

<= 9007199254740991

expected_head_seq

The head sequence required by the request.

integer format: int64

<= 9007199254740991

expected_inode_id

The request expected the path to contain this inode.

string

/^ino_[1-9][0-9]*$/

Example

ino_123

expected_revision_no

Revision the request expected to be current.

integer format: int64

<= 9007199254740991

fenced_writer_epoch

Epoch the failing writer session held when it was displaced.

integer format: int64

<= 9007199254740991

inode_id

Inode the failed precondition or operation targeted.

string

/^ino_[1-9][0-9]*$/

Example

ino_123

max_writer_sessions

Maximum writer sessions admitted by the node.

integer

namespace_id

The deleted namespace that caused the operation to fail.

string

/^[a-z0-9][a-z0-9._-]{0,127}$/

Example

demo

operation_index

The index of the failed operation in the request.

integer format: int32

precondition_index

Zero-based position of the failed request precondition.

integer format: int32

retention_floor_seq

Oldest sequence still promised for incremental replay.

integer format: int64

<= 9007199254740991

feature

The capability feature key for a not_supported error.

string

message

required

Human-readable error message.

string

param

The invalid JSON Pointer, parameter name, CLI flag, or CLI argument.

string

request_id

The request correlation ID also sent in the x-request-id response header.

string

404

Namespace not found

HTTP error body used by LoonFS APIs.

object

code

required

The stable machine-readable error code as a string.

string

details

The optional machine-readable context for the error code.

object

active_acquired_at_ms

The Unix-millisecond time when the current writer acquired its epoch, when available.

integer format: int64

active_writer_epoch

Epoch that currently owns the namespace.

integer format: int64

<= 9007199254740991

active_writer_id

The writer ID recorded for the current epoch, when available.

string

actual_access_revision_no

Access revision that is actually current for the inode.

integer format: int64

<= 9007199254740991

actual_attributes_revision_no

Attribute revision that is actually current for the inode.

integer format: int64

<= 9007199254740991

actual_binding_version

Current binding token; absent for the root, which has no binding.

string

/^[0-9a-f]+$/

actual_deletion_seq

Deletion sequence actually active for the inode.

integer format: int64

<= 9007199254740991

actual_head_seq

The actual namespace head sequence.

integer format: int64

<= 9007199254740991

actual_inode_id

The path actually contained this inode.

string

/^ino_[1-9][0-9]*$/

Example

ino_123

actual_revision_no

Revision that is actually current; absent when the inode has none.

integer format: int64

<= 9007199254740991

after_seq

Change-feed cursor the request asked to resume after.

integer format: int64

<= 9007199254740991

commit_id

Idempotency key of the commit the error concerns.

string

/^[a-z0-9][a-z0-9._-]{0,127}$/

Example

c_f3a9c2d4b6e8417a90c5d2f8e1b7a6c0

committed_fingerprint

The fingerprint of the mutation that landed under commit_id, present with committed_seq.

string

committed_seq

The sequence where this commit ID already landed, when recorded by a durable receipt.

integer format: int64

<= 9007199254740991

expected_access_revision_no

Access revision the request expected to be current.

integer format: int64

<= 9007199254740991

expected_attributes_revision_no

Attribute revision the request expected to be current.

integer format: int64

<= 9007199254740991

expected_binding_version

Opaque binding token supplied by the request.

string

/^[0-9a-f]+$/

expected_deletion_seq

Deletion sequence the undelete expected to be active.

integer format: int64

<= 9007199254740991

expected_head_seq

The head sequence required by the request.

integer format: int64

<= 9007199254740991

expected_inode_id

The request expected the path to contain this inode.

string

/^ino_[1-9][0-9]*$/

Example

ino_123

expected_revision_no

Revision the request expected to be current.

integer format: int64

<= 9007199254740991

fenced_writer_epoch

Epoch the failing writer session held when it was displaced.

integer format: int64

<= 9007199254740991

inode_id

Inode the failed precondition or operation targeted.

string

/^ino_[1-9][0-9]*$/

Example

ino_123

max_writer_sessions

Maximum writer sessions admitted by the node.

integer

namespace_id

The deleted namespace that caused the operation to fail.

string

/^[a-z0-9][a-z0-9._-]{0,127}$/

Example

demo

operation_index

The index of the failed operation in the request.

integer format: int32

precondition_index

Zero-based position of the failed request precondition.

integer format: int32

retention_floor_seq

Oldest sequence still promised for incremental replay.

integer format: int64

<= 9007199254740991

feature

The capability feature key for a not_supported error.

string

message

required

Human-readable error message.

string

param

The invalid JSON Pointer, parameter name, CLI flag, or CLI argument.

string

request_id

The request correlation ID also sent in the x-request-id response header.

string

503

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

code

required

The stable machine-readable error code as a string.

string

details

The optional machine-readable context for the error code.

object

active_acquired_at_ms

The Unix-millisecond time when the current writer acquired its epoch, when available.

integer format: int64

active_writer_epoch

Epoch that currently owns the namespace.

integer format: int64

<= 9007199254740991

active_writer_id

The writer ID recorded for the current epoch, when available.

string

actual_access_revision_no

Access revision that is actually current for the inode.

integer format: int64

<= 9007199254740991

actual_attributes_revision_no

Attribute revision that is actually current for the inode.

integer format: int64

<= 9007199254740991

actual_binding_version

Current binding token; absent for the root, which has no binding.

string

/^[0-9a-f]+$/

actual_deletion_seq

Deletion sequence actually active for the inode.

integer format: int64

<= 9007199254740991

actual_head_seq

The actual namespace head sequence.

integer format: int64

<= 9007199254740991

actual_inode_id

The path actually contained this inode.

string

/^ino_[1-9][0-9]*$/

Example

ino_123

actual_revision_no

Revision that is actually current; absent when the inode has none.

integer format: int64

<= 9007199254740991

after_seq

Change-feed cursor the request asked to resume after.

integer format: int64

<= 9007199254740991

commit_id

Idempotency key of the commit the error concerns.

string

/^[a-z0-9][a-z0-9._-]{0,127}$/

Example

c_f3a9c2d4b6e8417a90c5d2f8e1b7a6c0

committed_fingerprint

The fingerprint of the mutation that landed under commit_id, present with committed_seq.

string

committed_seq

The sequence where this commit ID already landed, when recorded by a durable receipt.

integer format: int64

<= 9007199254740991

expected_access_revision_no

Access revision the request expected to be current.

integer format: int64

<= 9007199254740991

expected_attributes_revision_no

Attribute revision the request expected to be current.

integer format: int64

<= 9007199254740991

expected_binding_version

Opaque binding token supplied by the request.

string

/^[0-9a-f]+$/

expected_deletion_seq

Deletion sequence the undelete expected to be active.

integer format: int64

<= 9007199254740991

expected_head_seq

The head sequence required by the request.

integer format: int64

<= 9007199254740991

expected_inode_id

The request expected the path to contain this inode.

string

/^ino_[1-9][0-9]*$/

Example

ino_123

expected_revision_no

Revision the request expected to be current.

integer format: int64

<= 9007199254740991

fenced_writer_epoch

Epoch the failing writer session held when it was displaced.

integer format: int64

<= 9007199254740991

inode_id

Inode the failed precondition or operation targeted.

string

/^ino_[1-9][0-9]*$/

Example

ino_123

max_writer_sessions

Maximum writer sessions admitted by the node.

integer

namespace_id

The deleted namespace that caused the operation to fail.

string

/^[a-z0-9][a-z0-9._-]{0,127}$/

Example

demo

operation_index

The index of the failed operation in the request.

integer format: int32

precondition_index

Zero-based position of the failed request precondition.

integer format: int32

retention_floor_seq

Oldest sequence still promised for incremental replay.

integer format: int64

<= 9007199254740991

feature

The capability feature key for a not_supported error.

string

message

required

Human-readable error message.

string

param

The invalid JSON Pointer, parameter name, CLI flag, or CLI argument.

string

request_id

The request correlation ID also sent in the x-request-id response header.

string