snapshots

Check the progress of a snapshot capture.

get/snapshots/{id}/status

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/snapshots/{id}/status
  • Auth: none declared. Required headers: x-organization-id

Path parameters

idstring required

Headers

x-organization-idstring required

Active organization id (or slug). Required for org-scoped operations; the generated client enforces it at compile time.

Response

Response

status'in_progress' | 'error' | 'complete' | 'deleted' required
errorMessagestring

Changes

No recorded changes to this operation across all 50 revisions of this API.