{
  "id": "export",
  "title": "Export database action requests",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/bdbs/actions/export/",
  "summary": "Export database requests",
  "content": "\n| Method | Path | Description |\n|--------|------|-------------|\n| [POST](#post-bdbs-actions-export) | `/v1/bdbs/{uid}/actions/export` | Initiate database export |\n\n## Initiate database export {#post-bdbs-actions-export}\n\n```sh\nPOST /v1/bdbs/{int: uid}/actions/export\n```\n\nInitiate a database export.\n\n### Permissions\n\n| Permission name | Roles |\n|-----------------|-------|\n| [start_bdb_export]() | admin\u003cbr /\u003ecluster_member\u003cbr /\u003edb_member |\n\n### Request {#post-request}\n\n#### Example HTTP request\n\n```sh\nPOST /v1/bdbs/1/actions/export\n```\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n\n#### URL parameters\n\n| Field | Type | Description |\n|-------|------|-------------|\n| uid | integer | The unique ID of the database |\n\n\n#### Body\n\nThe request body should contain a JSON object with the following export parameters:\n\n| Field | Type | Description |\n|-------|------|-------------|\n| export_location | [backup_location/export_location]() object | Details for the export destination. Call [`GET /v1/jsonschema`]() on the bdb object and review the `backup_location` field to retrieve the object's structure.  |\n| email_notification | boolean | Enable/disable an email notification on export failure/ completion. (optional) |\n\n##### Example JSON body\n\n```json\n{\n    \"export_location\": {\n        \"type\": \"url\",\n        \"url\": \"ftp://...\"\n    },\n    \"email_notification\": true\n}\n```\n\nThe above request initiates an export operation to the specified location.\n\n### Response {#post-response}\n\nReturns a status code.\n\n#### Status codes {#post-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | The request is accepted and is being processed. In order to monitor progress, the BDB's `export_status`, `export_progress`, and `export_failure_reason` attributes can be consulted. |\n| [404 Not Found](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5) | Attempting to perform an action on a nonexistent database. |\n| [406\u0026nbsp;Not\u0026nbsp;Acceptable](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7) | Not all the modules loaded to the database support 'backup_restore' capability |\n| [409 Conflict](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10) | Database is currently busy with another action. In this context, this is a temporary condition and the request should be reattempted later. |\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-04-01T08:10:08-05:00"
}