How to get your Syncro API key
Create a dedicated key in Syncro, choose the read permissions needed for your selected backup sources, and enter the account subdomain in RMMBackup. The steps below show where to find each value.
Create a least-privilege Syncro API key, find your account subdomain, choose read permissions, and fix common connection errors.
What you will learn
- Create and store a Syncro API key.
- Identify the Syncro subdomain and minimum read permissions.
- Diagnose authentication, permission, and visibility problems.
On this page
Prerequisites
Use a Syncro login allowed to manage API tokens. Syncro's security permissions reference says the API Tokens > Manage permission allows a user to generate tokens. Create a separate token for RMMBackup so it can be revoked independently.
Create the API key
- Open Admin > API - API Tokens; Syncro notes that Admin may be under More.
- Select + New Token, then Custom Permissions.
- Give the token a recognizable name and, if appropriate, an expiration date.
- Select the read permissions listed below and choose Create API Token.
- Copy the key before closing the page. Syncro does not show it again.
Do not paste the key into a URL, ticket, chat, or source file. Add it only to RMMBackup's provider-connection form.
Find the API URL and subdomain
RMMBackup asks for the subdomain, not a complete credential-bearing URL. If the account opens at https://example.syncromsp.com, enter example. Syncro's API base is https://{subdomain}.syncromsp.com/api/v1; the official Swagger instructions likewise ask for the subdomain as a server variable.
Choose minimum permissions
Enable the documented read permission for every selected source: Customers - List, Contacts - List, Assets - List/Search, Assets - View Details, and Assets - View BitLocker Recovery Key, Wiki Pages - List, Policies - List for Policy Folders, and RMM Alerts - List for RMM Alerts. Assets, Windows Patches, Installed Applications, Local Administrators, and BitLocker & Recovery Keys are separate backup-source choices. Each selected asset-related source uses its matching documented operation; BitLocker & Recovery Keys also follows each recovery-key reference to preserve the actual password. Syncro records every successful password reveal in the asset activity feed and credential-access log. Its API does not provide a non-revealing permission check, so RMMBackup confirms this permission during backup when it encounters a revealable key. Syncro's three Settings GET operations do not name an additional permission in the API reference.
Do not add create, edit, delete, or other write permissions. See exact current Syncro coverage before choosing collections.
Troubleshoot connection problems
- Unauthorized: confirm the copied key is complete, still active, and belongs to the same subdomain entered in RMMBackup.
- Forbidden: edit or replace the token with the missing collection's List permission. A valid token can still lack one required permission.
- Unexpectedly few records: check user visibility and each selected permission; do not treat a legitimately empty collection as an invalid key.
- Requests fail after rotation: replace the stored key. Creating or revoking a token does not update integrations automatically.
- Intermittent throttling: Syncro documents a per-IP API limit. Wait for the retry window instead of repeatedly resubmitting.
Continue with RMMBackup
Read how to back up Syncro, review native Syncro exports, or see the Syncro integration. RMMBackup is read-only and does not restore data to Syncro.
Frequently asked questions
Does RMMBackup need Syncro write permissions?
No. Its documented Syncro collectors use read operations; grant only the List or View permissions required for selected collections.
Why can a valid key return no records?
The selected collections may be empty or the token's user and permissions may limit visibility. An empty result alone does not prove the key is invalid.