name: Import Export API
route: /ImportExportAPI
menu: Documentation
submenu: Import/Exportimport themen from 'theme/styles/styled-colors'; import * as theme from 'react-syntax-highlighter/dist/esm/styles/hljs'; import SyntaxHighlighter from 'react-syntax-highlighter';
Export & Import REST APIs
What's New
The release of 0.8.3 includes the following improvements to Export and Import APIs:
- Export: Support for Incremental Export.
- Export & Import: Support for replicated attributes to entities made possible by SoftReference entity attribute option.
- Export option: skipLineage.
- New entity transforms framework.
- New AtlasServer entity type.
- Export: Automatic creation of HDFS path requested entities.
- New ExportImportAudits for Export & Import operations.
Background
The Import-Export APIs for Atlas facilitate transfer of data to and from a cluster that has Atlas provisioned.
The APIs when integrated with backup and/or disaster recovery process will ensure participation of Atlas.
Introduction
There are 2 broad categories viz. Export & Import. The details of the APIs are discussed below.
The APIs are available only to admin user.
Only a single import or export operation can be performed at a given time. The operations have a potential for generating large amount. They can also put pressure on resources. This restriction tries to alleviate this problem.
For Import-Export APIs relating to HDFS path, can be found here.
For additional information please refer to the following:
- ATLAS-1503 Original Import-Export API requirements.
- ATLAS-1618 Export API Scope Specification.
Errors
If an import or export operation is initiated while another is in progress, the consumer will receive this error:
{"ATLAS5005E": "Another import or export is in progress. Please try again."}
Unhandled errors will be returned as Internal error code 500.