> ## Documentation Index > Fetch the complete documentation index at: https://docs.hiloop.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get v1snapshots > List the caller's snapshots with optional source and name filters. Each snapshot carries the parent snapshot edge and materialized lineage used by later child sandboxes. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v1/snapshots openapi: 3.0.3 info: title: '' version: 0.0.1 servers: [] security: - bearerAuth: [] tags: - name: AnnotationSchemaService description: |- Org-scoped annotation-schema registry CRUD. Every RPC scopes to the caller's organization, derived from their credential; a request with no org scope is UNAUTHENTICATED. Registration runs a backward-compatibility check against the latest live version and REJECTS an incompatible change (FAILED_PRECONDITION). These endpoints are what the generated OpenAPI, SDKs, and CLI consume. - name: AnnotationService description: >- Typed annotation surface over the telemetry store: the annotate writes plus the one served annotation read every consumer shares. Organization scoping is enforced from request identity, not from the request body. Ingest of ordinary telemetry lives in TelemetryIngestService (telemetry.proto); the general event read surface lives in TelemetryQueryService (query.proto). - name: FeedbackService description: |- Product-feedback intake. The organization is derived from the caller's credential, never from the request body; a request with no org scope is UNAUTHENTICATED. Any org-scoped caller — a user session, a service key, or a sandbox-scoped credential — may submit feedback. - name: IdentityService description: Identity/health surface for the control-plane API. - name: MetaService description: Unauthenticated discovery surface for client-visible sibling service URLs. - name: ProjectService description: |- Org-scoped project CRUD. Every RPC scopes to the caller's organization, derived from their credential; a request with no org scope is UNAUTHENTICATED. These endpoints are what the generated OpenAPI, SDKs, and CLI consume. - name: RunService description: |- Org-scoped access to runs and their lineage. Every RPC scopes to the caller's organization, derived from their credential; a request with no org scope is UNAUTHENTICATED. These endpoints are what the generated OpenAPI, SDKs, and CLI consume. - name: SandboxService description: |- Org-scoped sandbox runtime API. The organization comes from the caller's credential. Org-scoped human and service credentials may use every route in their organization. A sandbox-scoped, lineage-confined credential may read its own sandbox and snapshot lineage and may exec or snapshot only that sandbox; it may not create, update, or delete sandboxes, delete snapshots, or exec into a sibling sandbox. State and verb rules are closed. Get and list serve every visible state. Failed and terminated rows remain available through GetSandbox for a server retention window, then return 404 not_found. Update to stopped is accepted from ready or running and is idempotent from stopped; update to running wakes stopped and is idempotent from running. A wake racing an in-flight stop waits for stop to win before wake proceeds. Workspace growth is accepted only for a stable durable sandbox and is idempotent for the same target; lifecycle mutation and growth never overlap. An undurable snapshot, including one whose request timed out, fences growth and cannot be deleted because its seal may still publish a late receipt; repeat the same snapshot request (and idempotency key, if supplied) to resolve its outcome. Delete is accepted once for a nonterminal sandbox; a second delete returns 404 not_found. Exec requires running and never wakes implicitly; any other non-quarantined state returns 409 sandbox_not_running. Snapshot is accepted from ready, running, or stopped; other non-quarantined states return 409 sandbox_not_ready. Every mutating verb on a quarantined sandbox returns 409 quarantined. A concurrent snapshot returns 409 snapshot_in_progress. Every error uses the flat {code, message, request_id} envelope. Stable route codes are invalid_argument (400), not_found (404), idempotency_conflict, name_conflict, sandbox_not_running, sandbox_not_ready, quarantined, snapshot_in_progress, snapshot_in_use, and snapshot_not_restorable, workspace_shrink_unsupported, and operation_conflict (409), unsupported_capability (422), quota_exceeded (429; details.quota.metric names the limit — sandboxes.running, sandboxes.total, or sandboxes.workspace_capacity_gib), and unavailable (503). Exec transport failures use spawn_failed or sandbox_stopped and discard any partial output; both mean the command did not run. A command that WAS dispatched but whose outcome could not be read is never an error: it returns 200 with the indeterminate outcome, alongside whatever partial output was collected, as a timeout does. Capability-receipt observation has no route in this version and is explicitly NOTIMPL; it is not inferred from Sandbox fields. - name: SecretService description: |- Org-scoped sandbox-secret management. Every RPC scopes to the caller's organization, derived from their credential; a request with no org scope is UNAUTHENTICATED. Create/revoke/rotate require an owner/admin in the organization; these management RPCs never return the secret value. - name: TelemetryViewService description: >- Typed data-view surface over the telemetry store. Organization scoping is enforced from request identity, not from the request body. A data view's spec is the engine's `DataViewSpec` — a raw `Sql` `SELECT` — re-validated and compiled fresh on every run under the forced-organization safe-SQL gateway. The untrusted raw-SQL escape hatch is a separate `POST /v1/telemetry/sql` endpoint, intentionally kept off this typed wire. - name: UsageService description: Org-scoped product quota reads. - name: VolumeService description: |- Org-scoped volume CRUD. Every RPC scopes to the caller's organization, derived from their credential; a request with no org scope is UNAUTHENTICATED. These endpoints are what the generated OpenAPI, SDKs, and CLI consume. - name: WorkloadService description: |- Org-scoped workload registry management. The organization is derived from the caller's credential; a request with no org scope is UNAUTHENTICATED. Registering and reading workloads is open to any org member. Setting a launch ACL and deleting a workload are operator actions and require an owner or admin in the organization. A sandbox-scoped credential may not register, delete, or manage workloads. paths: /v1/snapshots: get: tags: - SandboxService description: >- List the caller's snapshots with optional source and name filters. Each snapshot carries the parent snapshot edge and materialized lineage used by later child sandboxes. operationId: SandboxService_ListSandboxSnapshots parameters: - name: source_sandbox_id in: query description: Optional source sandbox id filter. schema: type: string - name: name in: query description: Optional exact snapshot-name filter. schema: type: string - name: page_size in: query description: >- Maximum number of snapshots to return. Zero uses the server default; the server caps it at 100. schema: type: integer format: uint32 maximum: 100 - name: page_token in: query description: >- Opaque token returned by a previous response. It binds the organization and every filter argument; changing any argument is rejected. Empty starts the first page. schema: type: string - name: id in: query description: Optional exact snapshot id filter. schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListSandboxSnapshotsResponse' default: $ref: '#/components/responses/SandboxError' components: schemas: ListSandboxSnapshotsResponse: type: object properties: snapshots: type: array items: $ref: '#/components/schemas/SandboxSnapshot' description: >- The snapshots on this page, ordered by created_at descending then id descending, including their parent lineage edges. next_page_token: type: string description: Token for the next page. Empty means this is the final page. required: - snapshots - next_page_token SandboxSnapshot: type: object properties: id: type: string description: The stable snapshot id. name: type: string description: Optional human-readable name supplied when the snapshot was created. source_sandbox_id: type: string description: The sandbox whose state this snapshot records. parent_snapshot_id: type: string description: >- The snapshot from which the source sandbox was created. Omitted for an image-created root. lineage_path: type: string description: >- The source sandbox's immutable lineage_path. A child created from this snapshot appends its id to this value, making snapshot parentage the derivation source for sandbox lineage. durability: enum: - local - replicated type: string description: The strongest durability currently confirmed for this snapshot. format: enum created_at: type: string description: When the snapshot was created, in RFC 3339 form. format: date-time image: type: string description: >- The workload image behind this snapshot's lineage: the root sandbox's OCI image reference, inherited by every child sandbox created from this snapshot. description: One immutable sandbox snapshot and its lineage edge. required: - id - source_sandbox_id - lineage_path - durability - created_at - image SandboxErrorBody: type: object additionalProperties: false required: - code - message - request_id properties: code: type: string description: Stable machine-readable error code in snake_case. message: type: string description: Human-readable description; clients must not parse it. request_id: type: string description: Correlation id for support and diagnostics. responses: SandboxError: description: An error using the successor flat API error envelope. headers: Retry-After: description: Seconds to wait before retrying when the error is retryable. schema: type: integer format: uint64 content: application/json: schema: $ref: '#/components/schemas/SandboxErrorBody' securitySchemes: bearerAuth: type: http scheme: bearer description: Hiloop API key sent as an HTTP Bearer token. ````