How to create OptiTune API credentials

At a glance

Generate dedicated credentials from OptiTune's My Account page, save the password when it appears, and choose an account type that can view every backup source you select. The steps below explain the required values and validation checks.

Generate dedicated OptiTune Basic-authentication credentials, choose least-privileged account access, and validate selected read resources safely.

Published Updated

On this page

Generate dedicated credentials

  1. Sign in to the OptiTune cloud management console with the account that will own the integration.
  2. Open My Account and scroll to the API credential section.
  3. Select Generate and immediately copy the generated API username and password. OptiTune says the password is displayed only once.
  4. Store the values in an approved secret manager until they are entered in RMMBackup. Never paste them into chat, source control, URLs, screenshots, or support tickets.

The official guide says API method availability depends on account type, including Administrator, Restricted Administrator, and Report Reader. Start with the least-privileged account type that can read all selected sources. If validation returns 403 for a source, adjust OptiTune access or deselect that source; do not grant remote-control or task-execution access for RMMBackup.

Enter and validate the credentials

In Settings > Integrations, choose OptiTune and enter the generated API username and password. RMMBackup stores both as encrypted secret fields and sends them only to the fixed https://manage.opti-tune.com API origin.

Select the intended sources and validate. The first check calls GET /api/v1/Accounts/Me; subsequent checks probe only selected read domains. Stored-file validation lists metadata but does not download file bytes. A successful validation is required before production-facing manual or scheduled backups are enabled.

Troubleshoot without exposing secrets

  • 401 Unauthorized: generate or recopy both API credential values and confirm the credential is still active.
  • 403 Forbidden: verify that the OptiTune account type can view the selected resource. Organization endpoints require master-administrator privileges according to the Swagger.
  • 429 Too Many Requests: let the client honor Retry-After; the official sources do not publish a fixed numeric limit.
  • One collection fails: leave the successful collections intact and investigate the selected permission domain. A failed collection is not an empty capture.

RMMBackup does not log response bodies or credentials and does not include configured API credentials in snapshots or ZIP exports. It also does not follow an OptiTune file URL to an unsafe destination or forward Basic credentials to a different host.

Rotate the credentials

Generate replacement API credentials in OptiTune, validate them against the existing provider connection, then save the replacement. Revoke the old values only after the new credentials pass the selected-source checks. Before switching to a different OptiTune account, download the history you need and review the connection-switching rules.

Frequently asked questions

What authentication does OptiTune use?

The official OptiTune API guide and Swagger define HTTP Basic authentication with an API username and password generated from My Account.

Does RMMBackup need write permissions?

No. RMMBackup calls documented GET operations only. The account still needs permission to view every selected resource.

Can the generated password be viewed again?

OptiTune says the password is shown only when the API credentials are generated, so store it securely or generate a replacement.

Official source

OptiTune REST API authentication guide

Official instructions for Basic authentication, My Account credential generation, one-time password display, and account-type-dependent API access.

Related OptiTune integration

Review current OptiTune backup coverage and availability.