> ## Documentation Index > Fetch the complete documentation index at: https://docs.microsandbox.dev/llms.txt > Use this file to discover all available pages before exploring further. # Get a snapshot operation ## OpenAPI ````yaml /api-reference/openapi.personal.json get /v1/orgs/{slug}/snapshot-operations/{operation_id} openapi: 3.1.0 info: title: Personal token API description: User-scoped API for account and organization management. version: 0.1.0 servers: - url: https://api.microsandbox.dev security: - bearer: [] paths: /v1/orgs/{slug}/snapshot-operations/{operation_id}: get: tags: - Snapshots summary: Get a snapshot operation operationId: get_operation parameters: - name: slug in: path description: Organization slug required: true schema: type: string - name: operation_id in: path description: Snapshot operation id required: true schema: type: string format: uuid responses: '200': description: Snapshot operation content: application/json: schema: $ref: '#/components/schemas/CloudSnapshotOperation' '401': description: Unauthorized '404': description: Snapshot operation not found security: - bearer: [] components: schemas: CloudSnapshotOperation: type: object description: |- Wire shape of the asynchronous snapshot operation returned by snapshot capture endpoints. required: - id - kind - status - created_at - updated_at properties: completed_at: type: - string - 'null' format: date-time description: Timestamp of the terminal status, when the operation has finished. created_at: type: string format: date-time description: Creation timestamp. error: oneOf: - type: 'null' - $ref: '#/components/schemas/CloudErrorDetails' description: Error details for a failed operation. id: type: string description: Server-side operation identifier. kind: $ref: '#/components/schemas/CloudSnapshotKind' description: Kind of snapshot being captured. result: oneOf: - type: 'null' - $ref: '#/components/schemas/CloudSnapshot' description: The resulting snapshot, present once the operation succeeds. status: $ref: '#/components/schemas/CloudSnapshotOperationStatus' description: Current operation status. updated_at: type: string format: date-time description: Timestamp of the most recent status change. CloudErrorDetails: type: object description: Nested cloud API error details. properties: code: type: - string - 'null' description: Machine-readable error code. message: type: - string - 'null' description: Human-readable error message. CloudSnapshotKind: type: string description: Kind of cloud snapshot artifact or capture operation. enum: - disk CloudSnapshot: oneOf: - allOf: - $ref: '#/components/schemas/CloudSnapshotDetails' description: Fields shared by every snapshot kind. - type: object description: A disk-only snapshot. required: - kind properties: kind: type: string enum: - disk description: A disk-only snapshot. description: Wire shape of a completed cloud snapshot. CloudSnapshotOperationStatus: type: string description: Status of an asynchronous cloud snapshot operation. enum: - queued - in_progress - succeeded - failed CloudSnapshotDetails: type: object description: Fields shared by every completed cloud snapshot kind. required: - name - location - digest - size_bytes - manifest - labels - created_at properties: created_at: type: string format: date-time description: Creation timestamp. digest: type: string description: 'Snapshot identity: the `sha256:` digest of the canonical descriptor.' labels: type: object description: User-defined labels stored on the snapshot. additionalProperties: type: string propertyNames: type: string location: $ref: '#/components/schemas/CloudSnapshotLocation' description: Where the snapshot artifact resides. manifest: $ref: '#/components/schemas/SnapshotManifest' description: Canonical snapshot descriptor. name: type: string description: Snapshot name. sandbox_id: type: - string - 'null' description: >- Identifier of the sandbox the snapshot was captured from, when known. size_bytes: type: integer format: int64 description: Stored payload size in bytes. minimum: 0 CloudSnapshotLocation: oneOf: - type: object description: Held in managed snapshot storage. required: - id - type properties: id: type: string description: Identifier of the stored artifact. type: type: string enum: - managed - type: object description: Stored in a directory on a mounted host volume. required: - path - type properties: path: type: string description: Artifact directory path on the host volume. type: type: string enum: - host_volume description: Public locator for a managed or host-volume cloud snapshot. SnapshotManifest: type: object description: >- Final schema-1 snapshot descriptor. Field order is identity-bearing. Do not reorder these fields. Generated bindings and API schemas expose this type as `SnapshotManifest`. required: - schema - artifact - scope - created_at - image - state - labels - extensions - requires properties: artifact: type: string description: Artifact kind. Exactly [`SNAPSHOT_ARTIFACT_KIND`]. created_at: type: string description: Normalized RFC 3339 creation timestamp. extensions: type: object description: Namespaced additive extension values. image: $ref: '#/components/schemas/ImageRef' description: Pinned base image. labels: type: object description: User-supplied labels, sorted by key in canonical form. additionalProperties: type: string propertyNames: type: string parent: type: - string - 'null' description: Exact snapshot identity of the logical lineage parent. requires: type: array items: type: string description: Sorted unique must-understand extension keys. schema: type: integer format: int32 description: Schema version. Exactly [`SCHEMA_VERSION`]. minimum: 0 scope: $ref: '#/components/schemas/SnapshotScope' description: Snapshot payload scope. source_sandbox: type: - string - 'null' description: Informational source-sandbox name. state: $ref: '#/components/schemas/SnapshotState' description: Closed file/checkpoint state variant. additionalProperties: false ImageRef: type: object description: Reference to the pinned OCI image used by the snapshot. required: - ref - manifest_digest properties: manifest_digest: type: string description: Pinned OCI manifest digest. ref: type: string description: Human-readable image reference. additionalProperties: false SnapshotScope: type: string description: Snapshot payload scope. enum: - disk - resumable SnapshotState: oneOf: - allOf: - $ref: '#/components/schemas/FileSnapshotState' description: Concrete file-backed disk state. - type: object required: - kind properties: kind: type: string enum: - file description: Concrete file-backed disk state. - allOf: - $ref: '#/components/schemas/CheckpointSnapshotState' description: Manifest-backed disk or resumable state. - type: object required: - kind properties: kind: type: string enum: - checkpoint description: Manifest-backed disk or resumable state. description: Closed snapshot state family. FileSnapshotState: type: object description: Concrete file-backed snapshot state. required: - format - fstype - upper properties: format: $ref: '#/components/schemas/SnapshotFormat' description: On-disk payload format. fstype: type: string description: Filesystem type inside the payload. upper: $ref: '#/components/schemas/UpperLayer' description: File-backed upper-layer binding. additionalProperties: false CheckpointSnapshotState: type: object description: Immutable checkpoint-manifest-backed snapshot state. required: - checkpoint_id - manifest properties: checkpoint_id: type: string description: Stable identifier for the captured cut. manifest: type: string description: SHA-256 identity of the disk or composite checkpoint manifest. additionalProperties: false SnapshotFormat: type: string description: On-disk format of a file-state upper layer. enum: - raw - qcow2 UpperLayer: type: object description: Captured file-state upper-layer metadata. required: - file - size_bytes properties: file: type: string description: One normal filename relative to the artifact directory. integrity: oneOf: - type: 'null' - $ref: '#/components/schemas/UpperIntegrity' description: >- Optional semantic payload integrity. The field itself is required so readers distinguish an intentional `null` from a malformed descriptor. size_bytes: type: integer format: int64 description: Apparent file size, including sparse holes. minimum: 0 additionalProperties: false UpperIntegrity: oneOf: - type: object description: |- Ordinary SHA-256 retained only for exact legacy compatibility and archive metadata. New file snapshots never emit this variant. required: - digest - algorithm properties: algorithm: type: string enum: - sha256 digest: type: string description: Algorithm output in qualified digest form. - type: object description: Released logical-byte sparse SHA-256 representation. required: - digest - algorithm properties: algorithm: type: string enum: - msb-sparse-sha256-v1 digest: type: string description: Algorithm output in qualified digest form. - type: object description: Current sparse-aware fixed-leaf BLAKE3 Merkle representation. required: - root - logical_size - leaf_size - algorithm properties: algorithm: type: string enum: - msb-file-merkle-blake3-v1 leaf_size: type: integer format: int32 description: Fixed leaf size. Exactly [`FILE_MERKLE_BLAKE3_LEAF_SIZE`]. minimum: 0 logical_size: type: integer format: int64 description: Exact logical file length bound into the final root. minimum: 0 root: type: string description: Domain-separated Merkle root in qualified digest form. description: Content integrity descriptor for a file-state upper layer. securitySchemes: bearer: type: http scheme: bearer description: >- Personal access token (msb_pat_…) or session JWT - the credential an agent acts with on a user's behalf. ````