export

Get export status

Retrieves the current status of an export operation, including progress for each collection being exported.

get/export/{backend}/{id}

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/export/{backend}/{id}
  • Auth: one of:
    • none
    • OAuth 2 (implicit, authorization URL http://to-be-configured-in-the-application-config)

Path parameters

backendstring required

The backend storage system where the export is stored.

idstring required

The unique identifier of the export.

Response

Successfully retrieved export status

idstring

Unique identifier for this export

backendstring

The backend storage system used

pathstring

Full path where the export is stored

status'STARTED' | 'TRANSFERRING' | 'SUCCESS' | 'FAILED' | 'CANCELED'

Current status of the export

startedAtstring date-time

When the export started

completedAtstring date-time

When the export completed (successfully, with failure, or was canceled)

tookInMsinteger

Duration of the export in milliseconds

classesstring[]

List of collections in this export

shardStatusobject

Per-shard progress: className -> shardName -> status

errorstring

Error message if export failed

Changes

No recorded changes to this operation across all 1 revision of this API.