How to create an Atera API token

At a glance

Atera administrators create tokens at Admin > Data management > API. Choose Custom access and Read for the RMM data domains used by the connection, then copy the token before closing the panel.

Create a dedicated Atera connection with the required read access and troubleshoot common expiration, location, and permission errors.

Published Updated

On this page

Prerequisites

Use an Atera account that can open Admin > Data management > API. Atera's API FAQ says the API is included with a subscription but unavailable during a trial. Decide whether to restrict requests to RMMBackup's known outbound IP before creating the token.

Create the API token

  1. Go to Admin > Data management > API and select New token.
  2. Name the token and choose an expiration date; Atera currently allows at most one year.
  3. Choose Specific IPs only when the production egress IP is stable and known; otherwise follow your organization's reviewed access policy.
  4. Choose Custom access, not Full access.
  5. Grant the read domains below, select Create, and copy the token immediately. Atera will not display it again.

API URL

Atera's public API documentation is at https://app.atera.com/apidocs, and RMMBackup uses the HTTPS Atera application origin with documented /api/v3/ reads. There is no tenant subdomain or region field in the current RMMBackup Atera connection.

Minimum read permissions

Grant Read for Customers, Contacts, Agents, Devices, Alerts, and Custom Values. These correspond to RMMBackup's documented customer, contact, managed-device, hardware-detail, monitoring-device, alert, and custom-field-value collections. Do not grant Write or Delete, and do not grant unrelated billing, contract, ticket, rate, or knowledge-base domains.

The token's IP rules and domain permissions both apply. Review Atera backup coverage for the exact supported collections.

Troubleshoot connection problems

  • Unauthorized: recopy the token and check its expiration date. If it was replaced or revoked, update the saved connection.
  • Forbidden or one collection fails: confirm that collection's domain has Read access; a token can authenticate while lacking one domain.
  • Works from one network only: check the token's Specific IPs allowlist against the application's outbound address.
  • No data: verify the relevant domain and account data. Empty results do not necessarily mean authentication failed.
  • No API during evaluation: confirm the account is no longer in Atera's trial period.

Frequently asked questions

Does Atera API access work during a trial?

Atera's official API FAQ says API access is not available during the trial period.

Does a valid Atera token always return every customer and device?

No. Token domain permissions and IP restrictions can limit access, and a selected resource can legitimately contain no records.

Official source

Using the Atera API

Related Atera integration

Review current Atera backup coverage and availability.