Sign in
Devbox
Devbox-PersistenceTools

Query the status of an asynchronous disk snapshot.

Get the current status of an asynchronous disk snapshot operation, including whether it is still in progress and any error messages if it failed.

get/v1/devboxes/disk_snapshots/{id}/status

Path parameters

idstring required

The Snapshot ID.

Response

Snapshot status retrieved successfully.

status'in_progress' | 'error' | 'complete' | 'deleted' required
error_messagestring nullable

Error message if the operation failed.

Changes

Changed in 4 of the 50 revisions of this API.554

  • d3ddb452754c541See the full diff
    • ▲

      the snapshot response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property snapshot/create_time_ms from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property snapshot/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property snapshot/metadata from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property snapshot/source_devbox_id from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property snapshot/commit_message from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property snapshot/name from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property snapshot/size_bytes from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property snapshot/source_blueprint_id from the response with the 200 status

      response-optional-property-removed

    • ○

      added DevboxDiskSnapshotView subschema #2 to the snapshot response property anyOf list for the response status 200

      response-property-any-of-added

  • c8d61a0c8b881See the full diff
    • ○

      added the optional property snapshot/size_bytes to the response with the 200 status

      response-optional-property-added

  • 5f33221208c111See the full diff
    • ●

      added the new deleted enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property snapshot/source_blueprint_id to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 436b4f5c74261See the full diff
    • ○

      added the optional property snapshot/commit_message to the response with the 200 status

      response-optional-property-added

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog