> ## Documentation Index
> Fetch the complete documentation index at: https://docs.baseten.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the archive status

> Reports whether the sandbox is frozen for an archive export, and which processes were stopped for it.



## OpenAPI

````yaml /reference/sandbox-api/openapi.json get /archive/status
openapi: 3.0.0
info:
  description: API for manipulating filesystem, processes and network.
  title: Sandbox API
  contact: {}
  version: 0.0.1
servers:
  - url: https://{sandbox_host}
    description: >-
      Host from the sandbox's returned url, without the scheme or trailing
      slash.
    variables:
      sandbox_host:
        default: sandbox.example.com
security:
  - BearerAuth: []
paths:
  /archive/status:
    get:
      tags:
        - archive
      summary: Get the archive status
      description: >-
        Reports whether the sandbox is frozen for an archive export, and which
        processes were stopped for it.
      responses:
        '200':
          description: Archive status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuiesceStatus'
components:
  schemas:
    QuiesceStatus:
      type: object
      required:
        - state
      properties:
        export:
          description: >-
            Export reports the export started asynchronously, if there was one.
            It is

            how a caller that did not wait for the export learns that the
            archive is

            on the storage, or why it is not.
          allOf:
            - $ref: '#/components/schemas/ExportProgress'
        readOnlyRoot:
          description: >-
            ReadOnlyRoot reports whether the root mount was remounted read-only,
            which

            is what actually stops writes; false means the freeze relies only on
            the

            API refusing calls, and the reason says why.
          type: boolean
          example: true
        reason:
          description: Reason is a human readable explanation of why the sandbox is frozen.
          type: string
          example: archive export
        restore:
          description: |-
            Restore reports the archive this sandbox was started from, if it was
            started from one: how far its restore has got, and how it ended.
          allOf:
            - $ref: '#/components/schemas/RestoreProgress'
        since:
          description: Since is when the sandbox left StateActive.
          type: string
        state:
          allOf:
            - $ref: '#/components/schemas/archive.QuiesceState'
          example: quiesced
        stoppedProcesses:
          description: >-
            StoppedProcesses are the process identifiers stopped while
            quiescing.
          type: array
          items:
            type: string
    ExportProgress:
      type: object
      properties:
        error:
          description: Error is why the export failed, without the presigned URL it used.
          type: string
        finishedAt:
          type: string
        size:
          description: >-
            Size is the archive's exact size, known once the filesystem is
            scanned.
          type: integer
          example: 3074211
        startedAt:
          type: string
        state:
          allOf:
            - $ref: '#/components/schemas/archive.ExportState'
          example: running
        uploaded:
          description: Uploaded reports whether the storage holds the archive.
          type: boolean
          example: false
    RestoreProgress:
      type: object
      properties:
        deleted:
          type: integer
          example: 3
        downloaded:
          description: Downloaded is how much of the archive has been read so far.
          type: integer
          example: 1048576
        error:
          description: Error is why the restore failed, without the presigned URL it used.
          type: string
        finishedAt:
          type: string
        restored:
          description: >-
            Restored and Deleted count what the archive changed on the
            filesystem.
          type: integer
          example: 1204
        size:
          description: >-
            Size is the archive's size as the storage announced it, and zero
            when it

            announced none - a client showing a percentage has to allow for
            that.
          type: integer
          example: 3074211
        startedAt:
          type: string
        state:
          allOf:
            - $ref: '#/components/schemas/archive.RestoreState'
          example: extracting
    archive.QuiesceState:
      type: string
      enum:
        - active
        - quiescing
        - quiesced
        - restoring
      x-enum-varnames:
        - StateActive
        - StateQuiescing
        - StateQuiesced
        - StateRestoring
    archive.ExportState:
      type: string
      enum:
        - running
        - succeeded
        - failed
      x-enum-varnames:
        - ExportRunning
        - ExportSucceeded
        - ExportFailed
    archive.RestoreState:
      type: string
      enum:
        - downloading
        - extracting
        - relaunching
        - succeeded
        - failed
      x-enum-varnames:
        - RestoreDownloading
        - RestoreExtracting
        - RestoreRelaunching
        - RestoreSucceeded
        - RestoreFailed
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Sandbox access token created through POST /v1/token.

````