Cloud Sync Guide
Access your API collections and environments from any device with encrypted cloud sync powered by Firebase.
Overview
Cloud Sync enables you to access your collections, environments, and configurations from any iOS device where you're signed in. All data is encrypted end-to-end using AES-256-GCM before leaving your device, ensuring that your API keys, tokens, and request data remain secure.
Cloud Sync is powered by Firebase and works seamlessly across iPhone and iPad. You can continue working offline, and changes will automatically sync when you reconnect to the internet.
Sign In
To use Cloud Sync, you need to sign in with a RestForge account. Three authentication methods are available:
Email & Password
Open Settings
Tap the settings icon in the bottom navigation bar, then tap Sign In.
Enter Credentials
Enter your email address and password. If you don't have an account, tap Create Account to register.
Verify Email
Check your inbox for a verification email. Click the link to activate your account. You can resend the verification email from the app if needed.
Google Sign-In
Choose Google
From the sign-in screen, tap Continue with Google.
Select Account
A Google sign-in sheet will appear. Select the Google account you want to use or add a new account.
Grant Permissions
Review the permissions and tap Continue. RestForge only accesses your email and basic profile information.
Sign in with Apple
Choose Apple
From the sign-in screen, tap Sign in with Apple.
Authenticate
Use Face ID, Touch ID, or your device passcode to authenticate. You can choose to share or hide your email address.
Complete Sign-In
Tap Continue to complete the sign-in process. You'll be returned to the app.
Enable Cloud Sync
After signing in, you can enable Cloud Sync to start syncing your data across devices.
Navigate to Settings
Tap the settings icon in the bottom navigation bar. You should see your account email displayed at the top.
Toggle Cloud Sync
Find the Cloud Sync toggle switch and turn it on. A confirmation dialog will appear explaining what data will be synced.
Initial Upload
The first sync will upload all your local collections, environments, and settings to the cloud. This may take a few seconds depending on how much data you have. A progress indicator will show the upload status.
Real-Time Sync Enabled
After the initial upload, all subsequent changes are synced in real-time. You'll see a sync status indicator in the settings screen.
Once enabled, Cloud Sync runs automatically in the background. You don't need to manually trigger syncs.
What Gets Synced
Cloud Sync automatically syncs the following data across all your devices:
Collections
- All collections and folders with their hierarchical structure
- Individual API requests including method, URL, headers, and body
- Request configurations like timeout settings and SSL verification options
- Pre-request scripts and post-response scripts
- Authorization settings for each request
Environments
- All environment configurations with their variables
- Variable names, values, and enabled/disabled states
- Active environment selection across devices
Settings
- App preferences like theme and display options
- Request defaults including timeout values
- Editor preferences and syntax highlighting settings
What Does NOT Sync
The following data is stored locally on each device and is not synced:
- Request History: Your request history remains local for privacy and performance reasons
- Scheduled Tasks: Automation schedules are device-specific
- Temporary Variables: Runtime variables set during script execution
- Cache Data: Response caches are stored locally
Encryption & Security
RestForge takes security seriously. All synced data is encrypted using industry-standard encryption before it leaves your device.
Encryption Algorithm
Data is encrypted using AES-256-GCM (Advanced Encryption Standard with 256-bit keys in Galois/Counter Mode). This is the same encryption standard used by banks and government institutions.
End-to-End Encryption
Encryption happens on your device before data is transmitted to Firebase. The encryption key is derived from your user account and never leaves your device. This means:
- Your data is encrypted during transmission over the internet
- Your data is stored encrypted on Firebase servers
- Only devices signed in with your account can decrypt the data
- RestForge servers cannot read your API keys, tokens, or request data
Key Management
The encryption key is generated using a combination of your user ID and device-specific secure storage. Each device that signs in derives the same encryption key, allowing seamless decryption across devices.
Security Best Practices
- Use a strong password for email/password authentication
- Enable two-factor authentication on your Google or Apple account
- Sign out from devices you no longer use
- Regularly review which devices have access in your account settings
Offline Mode
RestForge works seamlessly offline. You don't need an internet connection to use the app or send API requests.
Local Storage Fallback
All your collections, environments, and settings are stored locally on your device using SQLite and SharedPreferences. When offline:
- You can create new requests and collections
- You can edit existing requests and environments
- You can send API requests if the target API is reachable
- All changes are queued for sync when you reconnect
Sync Queue
When you make changes while offline, they're added to a sync queue. Once you reconnect to the internet:
- The app automatically detects the connection
- Queued changes are uploaded to Firebase
- Remote changes from other devices are downloaded
- Conflicts are automatically resolved (see Cross-Device Sync)
Sync Status Indicator
The app displays a sync status icon in the settings screen:
- Green checkmark: All changes synced successfully
- Yellow upload icon: Sync in progress
- Red offline icon: No internet connection, changes queued
- Gray cloud: Cloud Sync disabled
Cross-Device Sync
Use RestForge on multiple devices simultaneously. Changes made on one device appear on others within seconds.
Supported Devices
Cloud Sync works between:
- iPhone to iPhone
- iPad to iPad
- iPhone to iPad and vice versa
You can sign in on unlimited devices with a single RestForge Premium account.
Real-Time Sync
When you make a change on one device:
Change Detection
The app detects the change immediately (e.g., saving a request, updating a variable).
Encryption & Upload
The change is encrypted and uploaded to Firebase within 1-2 seconds.
Push Notification
Firebase sends a push notification to all other signed-in devices.
Download & Decrypt
Other devices download the encrypted change, decrypt it, and update the local database.
UI Update
The app UI refreshes automatically to show the new data.
Conflict Resolution
If two devices modify the same request or environment simultaneously, RestForge uses a last-write-wins conflict resolution strategy:
- Changes are timestamped with server time (not device time)
- The change with the most recent timestamp is kept
- Conflicting changes from older timestamps are discarded
Merge vs. Replace
When syncing changes:
- New items (collections, requests, environments) are added on all devices
- Edited items use last-write-wins based on timestamp
- Deleted items are removed on all devices
Migration Wizard
If you have existing local data when you sign in for the first time, the Migration Wizard helps you merge local and cloud data safely.
When Does the Wizard Appear?
The wizard automatically appears when:
- You sign in for the first time on a device
- The device has local collections or environments
- The cloud account already has synced data from another device
Migration Options
The wizard presents three options:
| Option | What Happens | Use When |
|---|---|---|
| Keep Local Data | Replaces cloud data with local data. Local collections overwrite cloud. | You want to use this device's data and discard cloud data. |
| Keep Cloud Data | Replaces local data with cloud data. Downloads collections from cloud. | You want to use data from another device and discard local data. |
| Merge Both | Combines local and cloud data. Collections with same names are merged. | You want to keep data from both sources. Best option in most cases. |
Merge Strategy
When you choose Merge Both:
- Collections with different names are added from both sources
- Collections with the same name are merged (requests from both are kept)
- Environments with different names are added from both sources
- Environments with the same name use cloud version (local version is renamed)
Post-Migration Cleanup
After migration, you may see:
- Duplicate collections (review and delete unwanted ones)
- Renamed environments with "(Local)" suffix
- Extra folders that can be consolidated
Take a few minutes to clean up duplicates and organize your collections after migration.
Troubleshooting
Common Cloud Sync issues and how to resolve them.
Sync Not Working
Symptoms: Changes on one device don't appear on another, or sync status shows "offline" despite internet connection.
Solutions:
- Check your internet connection in Settings → Wi-Fi or Cellular
- Verify Cloud Sync is enabled in RestForge settings
- Confirm you're signed in to the same account on both devices
- Force quit the app and reopen it to reset sync connection
- Check if Firebase is experiencing outages (rare): status.firebase.google.com
Data Missing After Sign-In
Symptoms: You sign in on a new device but your collections don't appear.
Solutions:
- Wait 10-15 seconds for initial sync to complete (large accounts take longer)
- Pull down on the collections list to force refresh
- Verify you signed in with the correct account (check email in settings)
- Check if collections exist on another device where you use RestForge
- If you previously used RestForge without signing in, your data is local only. Sign in first, then enable Cloud Sync to upload.
Sync Conflicts
Symptoms: A request or environment appears different than expected, or recent changes disappeared.
Solutions:
- Check request history to see if you can recover the lost version (history is local per device)
- Review the item on another device to see which version was kept
- Manually restore the desired changes by editing the item again
- To avoid conflicts, finish editing on one device before switching to another
Sign-In Errors
Symptoms: "Sign in failed" or "Authentication error" messages.
Solutions:
- For Email/Password: Verify email is correct and check for typos in password
- For Email/Password: Check your inbox for verification email if account is new
- For Google Sign-In: Ensure you're connected to internet and Google services aren't blocked
- For Apple Sign-In: Verify Face ID/Touch ID is working and you're signed in to iCloud
- Force quit the app and try signing in again
- If issue persists, try a different sign-in method (e.g., Google instead of email)
Performance Issues
Symptoms: App slows down after enabling Cloud Sync, or syncs take a long time.
Solutions:
- Large accounts (100+ collections, 1000+ requests) may sync slower. This is normal.
- Initial sync after sign-in takes longer than subsequent syncs
- Close other apps to free up device memory
- Ensure you're on a stable Wi-Fi connection for large syncs
- Consider archiving old collections you no longer need
Contact Support
If none of the above solutions work, contact RestForge support:
- Email: support@restforge.org
- In-App: Settings → Help & Support → Contact Us
Include the following information for faster resolution:
- Your account email (not password)
- Device model and iOS version
- Description of the issue and steps to reproduce
- Screenshots of any error messages
Premium Features
Cloud Sync is a premium feature included with RestForge Premium subscription.
What's Included with Premium
- Unlimited Cloud Sync: Sync unlimited collections, environments, and requests
- Unlimited Devices: Sign in on all your iPhones and iPads
- End-to-End Encryption: AES-256-GCM encryption for all synced data
- Real-Time Sync: Changes appear on other devices within seconds
- Offline Support: Full offline mode with automatic sync queue
- Priority Support: Faster response times from support team
Subscription Options
RestForge Premium is available as:
- Monthly: $4.99/month, cancel anytime
- Annual: $49.99/year (save 17%), two months free
All subscriptions include a 7-day free trial. No credit card required to start trial.
Upgrade to Premium
Open Premium Screen
Tap Settings → Upgrade to Premium, or tap any "Premium" badge in the app.
Choose Plan
Select Monthly or Annual subscription. Compare features and pricing.
Start Trial
Tap "Start 7-Day Free Trial". Authenticate with Face ID, Touch ID, or password.
Enable Cloud Sync
After upgrading, go to Settings and toggle Cloud Sync on to start syncing.
Free Features
Without Premium, RestForge still offers:
- Unlimited API requests
- Local collections and environments
- Request history
- Basic scripting (pre-request and post-response)
- Import/Export (Postman, cURL, etc.)
Cloud Sync, advanced scripting, and automation features require Premium.
Next Steps:
- Getting Started - Set up RestForge in under 2 minutes
- Collections Guide - Organize API requests into collections
- Environments Guide - Use variables for different API environments
- All Documentation - Browse all user guides