How to create a Gorelo API key for RMM backup
Create a dedicated Gorelo API key for the RMM and asset-context sources you select, save it securely, and validate every selected source before enabling backups.
Create and validate a dedicated Gorelo API key with access to the selected RMM and asset-context resources.
On this page
Generate a dedicated key
- Sign in to the Gorelo account you intend to back up.
- Open Settings > Integrations.
- Select the cog for the API integration.
- Choose Generate New Key.
- Enter a name that identifies RMMBackup and an optional purpose description.
- Select read access for Clients, Contacts, Assets, Alerts, Uptime, and the client/contact/custom-asset deletion records needed by the categories you enable.
- Generate the key and copy it to an approved secret manager until it is saved in RMMBackup.
Use a dedicated key so it can be rotated or revoked without affecting another integration. Never put the key in a URL, source control, screenshots, chat, fixtures, reports, or support logs.
Enter the region and validate access
In Settings > Integrations, choose Gorelo, leave the region set to United States, paste the key into the masked field, and select the categories to back up. The Gorelo connection currently supports the US region at https://api.usw.gorelo.io/.
Validation sends the key through X-API-Key and checks every selected read category. A valid empty collection passes because empty data does not mean the permission is missing. A selected category returning 403 fails validation rather than being hidden.
Troubleshoot without exposing the key
- 401 Unauthorized: recopy the key and confirm it has not been revoked.
- 403 Forbidden: add the official read scope for the selected source, then validate again.
- 429 Too Many Requests: allow the shared request coordinator and
Retry-Afterhandling to pace retries. - One category fails: confirm that exact source remains selected and that the key has its read scope. A failed collection cannot replace its last successful comparison baseline.
- Region error: use the US region unless Gorelo publishes and the integration verifies another official endpoint.
RMMBackup stores the customer key through its encrypted provider credential store. Logs contain sanitized error categories and adapter-authored messages, not the key or provider response body.
Rotate or revoke the key
Generate a replacement key for the same Gorelo account, validate it against the existing connection, and save it before revoking the old key. Gorelo's API settings page also provides the official revoke action. Before switching to a different Gorelo account, download the history you need and review the connection-switching rules.
Frequently asked questions
Which header does the Gorelo API use?
Gorelo requires the raw key in the X-API-Key header on every request.
Does RMMBackup need permission to change Gorelo data?
No. The Gorelo adapter calls only documented GET operations and does not use create, update, delete, execute, scan, or remote-session operations.
Official source
Official Gorelo instructions for generating and revoking API keys, selecting scopes, authenticating, and handling API errors.