Backups & Import/Export
RestAPI.com provides comprehensive tools to backup, restore, and migrate your API data through the Developer Portal.
Overview
Access these features via Import & Export in your API:
| Feature | Description |
|---|---|
| Export | Create ZIP backups of structure, data, files, and settings |
| Import | Restore from ZIP archives |
| Takeout | Generate SQL scripts for database-level backups |
| Jobs | Monitor all background operations |
Export
Create on-demand backups of your API.
What Can Be Exported
| Option | Description |
|---|---|
| Structure | Collections, properties, relationships, views, queries, functions |
| Items | Collection data records |
| Blobs | Uploaded files, images, documents |
| VFS | Virtual file system files (application files) |
| Settings | API configuration key-value pairs |
| WebApp | Web application configuration |
| Auth Providers | OAuth/authentication provider configurations |
Export Workflow
- Navigate to Import & Export → Export
- Select components to include
- Enter a secrets passphrase if the export needs to carry secrets
- Click Export
- Download the ZIP file from Jobs when complete
Secrets Encryption
The passphrase does more than encrypt — it decides whether secrets travel at all. Provide one and your API secrets and authentication provider credentials are included, each encrypted with it. You will need the same passphrase when importing.
An export without a passphrase silently leaves secrets out. They are omitted rather than written in the clear, and nothing in the archive marks them as missing.
The gap only shows up at import, when functions fail against absent credentials. If your backup is meant to be restorable on its own, set a passphrase and store it somewhere you will still have it.
Import
Restore data from export archives.
What Can Be Imported
| Option | Description |
|---|---|
| Structure | Schema definitions |
| Items | Collection data records |
| Blobs | Binary files |
| VFS | Application files |
| Purge | Delete existing data before import |
Import Workflow
- Navigate to Import & Export → Import
- Upload one or more ZIP files
- Select components to import
- If the export was encrypted, enter the secrets passphrase
- Click Import
The Purge option permanently deletes all existing data before importing. This is destructive and cannot be undone. Use with extreme caution.
Multi-File Import
You can upload and import multiple ZIP archives in a single job. All files are processed together.
Takeout
Generate SQL scripts for complete database backups.
What's Included
| Option | Description |
|---|---|
| Structure | SQL CREATE statements for tables and relationships |
| Data | SQL INSERT statements for all records |
What's NOT Included
- Binary files (blobs)
- Application files (VFS)
Use Takeout for:
- Database-level recovery
- GDPR compliance and data portability
- SQL-based migrations
Takeout Workflow
- Navigate to Import & Export → Takeout
- Select structure and/or data
- Click Create Takeout
- Download SQL file from Jobs
Jobs
All export, import, and takeout operations run as background jobs.
Job Status
| Status | Description |
|---|---|
| Pending | Queued, waiting to start |
| Running | Actively processing |
| Completed | Finished successfully |
| Failed | Error occurred |
| Cancelled | Cancelled by user |
Job Features
- Progress tracking — Real-time percentage completion
- Auto-refresh — Optional automatic updates
- Filtering — Filter by job type (Export, Import, Takeout)
- Detailed logs — View execution logs with timestamps
- Download files — Direct download links for completed exports
- Cancel jobs — Stop pending or running jobs
- Delete jobs — Remove completed jobs from history
Job Logs
Each job maintains detailed logs with entries categorized as:
- Info — Normal progress updates
- Warning — Non-critical issues
- Error — Problems that may affect results
- File — Downloadable output files
File Storage
Export and takeout files are stored in secure cloud storage:
- Format: ZIP archives (Export/Import) or SQL files (Takeout)
- Access: Time-limited secure download URLs
- Retention: Files remain available until manually deleted
- Multiple downloads: Same file can be downloaded multiple times
Use Cases
| Scenario | Approach |
|---|---|
| Full backup | Export: Structure + Items + Blobs |
| Schema only | Export: Structure only (fast, small) |
| Environment migration | Export from production → Import to staging |
| API cloning | Export structure → Import to new API |
| Disaster recovery | Regular exports stored securely |
| GDPR compliance | Takeout for data portability requests |
| Database backup | Takeout for SQL-based recovery |
| Version control | Export structure for git commits |
Best Practices
- Export regularly — Create periodic backups of critical APIs
- Always include structure — Schema is essential for complete backups
- Test restores — Verify backups by importing to a test API
- Secure storage — Store export files in redundant, secure locations
- Use passphrases — An export without one carries no secrets at all, so set a passphrase whenever the archive needs to restore on its own
- Monitor jobs — Check job logs for warnings or errors
- Clean up old jobs — Delete completed jobs you no longer need