add /export route

Author: guimachiavelli

.code-samples.meilisearch.yaml

@@ -1467,6 +1467,18 @@ related_results_similar_1: |-
       "id": 192,
       "embedder": "EMBEDDER_NAME"
     }'
+export_post_1: |-
+  curl \
+    -X POST 'MEILISEARCH_URL/export' \
+    -H 'Content-Type: application/json' \
+    --data-binary '{
+      "url": "TARGET_INSTANCE_URL",
+      "indexes": {
+        "*": {
+          "overrideSettings": true
+        }
+      }
+    }'
 
 ### Code samples for experimental features
 experimental_get_metrics_1: |-

docs.json

@@ -342,7 +342,8 @@
                   "reference/api/dump",
                   "reference/api/experimental_features",
                   "reference/api/metrics",
-                  "reference/api/logs"
+                  "reference/api/logs",
+                  "reference/api/export"
                 ]
               },
               {

reference/api/export.mdx

@@ -0,0 +1,64 @@
+---
+title: Export
+description: "Migrate between instances with the `/export` route"
+---
+
+import { RouteHighlighter } from '/snippets/route_highlighter.mdx'
+
+import CodeSamplesExperimentalDeleteLogsStream1 from '/snippets/samples/code_samples_experimental_delete_logs_stream_1.mdx';
+
+Use the `/export` route to transfer data from your origin instace to a remote target instance. This is particularly useful when migrating from your local development environment to a Meilisearch Cloud instance.
+
+## Migrate database between instances
+
+<RouteHighlighter method="POST" path="/export" />
+
+Migrate data from the origin instance to a target instance.
+
+### Body
+
+| Name                | Type   | Default value | Description                                                                                               |
+| ------------------- | ------ | ------------- | --------------------------------------------------------------------------------------------------------- |
+| **`url`** *         | String | `null`        | The target instance's URL address. Required                                                               |
+| **`apiKey`** *      | String | `null`        | An API key with full admin access to the target instance                                                  |
+| **`payloadSize`** * | String | "50 MiB"      | A string specifying the payload size in a human-readable format                                           |
+| **`indexes`** *     | Object | `null`        | A set of patterns matching the indexes you want to export. Defaults to all indexes in the origin instance |
+
+#### `url`
+
+A string pointing to a remote Meilisearch instance, including its port if necessary.
+
+This field is required.
+
+#### `apiKey`
+
+A security key with full admin permissions to a secured Meilisearch instance.
+
+#### `payloadSize`
+
+The maximum size of each single data payload in a human-readable format such as `"100MiB"`. Larger payloads are generally more efficient, but require significantly more powerful machines.
+
+#### `indexes`
+
+A set of objects whose keys correspond to patterns matching the indexes you want to export. By default, Meilisearch exports all documents across all indexes.
+
+Each index object accepts the following fields:
+
+- `filter`: a [filter expression](/learn/filtering_and_sorting/filter_expression_reference) defining the subset of documents to export. Optional, defaults to `null`
+- `overrideSettings`: if `false`, uses the index settings as configured in the origin instance. if `true`, uses the target instance settings. Optional, defaults to `false`.
+
+### Example
+
+<CodeSamplesExportPost1 />
+
+#### Response
+
+```json
+{
+  "taskUid": 2,
+  "indexUid": null,
+  "status": "enqueued",
+  "type": "export",
+  "enqueuedAt": "2025-06-26T12:54:10.785864Z"
+}
+```

reference/errors/error_codes.mdx

@@ -184,6 +184,26 @@ The [`offset`](/reference/api/documents#query-parameters) parameter is invalid.
 
 The provided `_geo` field of one or more documents is invalid. Meilisearch expects `_geo` to be an object with two fields, `lat` and `lng`, each containing geographic coordinates expressed as a string or floating point number. Read more about `_geo` and how to troubleshoot it in [our dedicated guide](/learn/filtering_and_sorting/geosearch).
 
+## `invalid_export_url`
+
+The export target instance URL is invalid or could not be reached.
+
+## `invalid_export_api_key`
+
+The supplied security key does not have the required permissions to access the target instance.
+
+## `invalid_export_payload_size`
+
+The provided payload size is invalid. The payload size must be a string indicating the maximum payload size in a human-readable format.
+
+## `invalid_export_indexes_patterns`
+
+The provided index pattern is invalid. The index pattern must be an alphanumeric string, optionally including a wildcard.
+
+## `invalid_export_index_filter`
+
+The provided index export filter is not a valid [filter expression](/learn/filtering_and_sorting/filter_expression_reference).
+
 ## `invalid_facet_search_facet_name`
 
 The attribute used for the `facetName` field is either not a string or not defined in the [`filterableAttributes` list](/reference/api/settings#filterable-attributes).