export

Start a new export

Initiates an export operation on the specified backend storage (S3, GCS, Azure, or filesystem). The output format is controlled by the required 'file_format' field in the request body (currently only 'parquet' is supported). Each collection is exported to a separate file.

post/export/{backend}

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/export/{backend}
  • 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 to use for the export (e.g., filesystem, gcs, s3, azure).

Request body

idstring required

Unique identifier for this export. Must be URL-safe.

file_format'parquet' required

Output file format for the export.

includestring[]

List of collection names to include in the export. Cannot be used with 'exclude'.

excludestring[]

List of collection names to exclude from the export. Cannot be used with 'include'.

Response

Successfully started export operation

idstring

Unique identifier for this export

backendstring

The backend storage system used

pathstring

Full path where the export is being written

status'STARTED'

Current status of the export

startedAtstring date-time

When the export started

classesstring[]

List of collections being exported

Changes

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