The Atera API lets you integrate Atera with external tools, streamline workflows, and automate processes. To authenticate with the API, you need an API token. Legacy API keys are being retired, so any integration that still uses one must be switched to an API token. You can create multiple tokens with different configurations to manage access across different use cases.

Important: Legacy API keys stop working on December 10, 2026. Since November 10, 2026, the legacy API key page is no longer available in Atera and new legacy keys can't be created. Existing legacy keys keep working until December 10. To avoid broken integrations, switch every tool and script to an API token before then. For the steps, see Update third-party tools to use an API token.

Note: 

• Send API requests to https://api.atera.com. Atera supports API requests over HTTPS only.
• Atera's API uses MSP terminology, which may differ from IT Department terms. For a full comparison, see Terminology differences between the MSP and IT Department products.

Available API data domains and fields

The API provides access to structured data across multiple domains in the platform. Each domain represents a resource (such as agents, tickets, or alerts) and includes a defined set of fields you can query.

Available domains include:

• Agents (e.g., MachineID, AgentID, DeviceGUID, FolderID)
• Alerts (e.g., AlertID, Code, Source, Title)
• Billing (e.g., InvoiceID, InvoiceNumber, InvoiceNumberAsString)
• Contacts (e.g., EndUserID, CustomerID, CustomerName, JobTitle)
• Contracts (e.g., CustomerID, ContractName, ContractType, Active)
• Customers (e.g., CustomerID, CustomerName, CreatedOn, LastModified)
• CustomValues (e.g., ItemID, ID, FieldName, ValueAsString)
• Departments (e.g., ID, Name, Description)
• Devices (e.g., Name, DeviceID, DeviceGuid, CustomerID)
• KnowledgeBase (e.g., KBID, KBTimestamp, KBContext, KBProduct)
• Rates (e.g., RateID, Amount, Description, SKU)
• Tickets (e.g., TicketID, TicketTitle, EndUserID, EndUserEmail)

Each endpoint returns records with these fields, enabling you to retrieve, filter, and integrate data based on your needs.

Create an API token

API tokens are used to authenticate requests to Atera's API. They replace legacy API keys, which stop working on December 10, 2026. You can create multiple tokens with different configurations to manage access across different use cases and environments. We recommend creating a separate token for each integration, so you can revoke one integration without affecting the others.

Important: Only admins can create API tokens. If you’re a technician without admin permissions, ask an admin on your account to create the token for you.

To create an API token:

1. From your dashboard, go to Admin > Data management > API.

The API page appears.

2. Click New token.

The Create new token panel appears.

3. Fill out the following fields:

• Token: Enter the name of your API token.
• Expiration date: Select an expiration date for your token (the maximum is one year from the creation date).
• IP addresses:
  • Select Allow all to permit requests from any IP address to execute API methods using the token.
  • Select Specific IPs to allow only designated IP addresses to execute API methods using the token.
• API permissions:
  • Select Full access to enable all permissions (Read, Write, Delete) for all domains.
  • Select Custom access to set specific permissions per domain.

4. Click Create.

Important: Copy and store the token before you close the panel. It won't be shown again. You'll need this token every time you authenticate on the API documentation page and in every tool that uses it. Keep it secret and safe, because it gives access to your users and their devices.

Authenticate with an API token

To interact with Atera's API, you must authenticate on the API documentation page using an API token you've created.

To authenticate using your API token:

1. From your dashboard, go to Admin > Data management > API.

The API page appears.

2. Click API documentation.

You'll be redirected to the Atera API documentation page.

3. Enter your API token and click Set.

You're all set! You can now start interacting with the API.

Update third-party tools to use an API token

Legacy API keys stop working on December 10, 2026. Any third-party tool, integration, or script that still connects to Atera with a legacy API key will stop working on that date. To keep your integrations running, an admin must replace the legacy API key with an API token in each one before the cutoff.

To switch a tool from a legacy API key to an API token:

1. List every tool, integration, and script that connects to Atera with your legacy API key.

2. Create an API token for each tool, with only the permissions that tool needs. For the steps, see Create an API token.

3. In each tool's settings, replace the legacy API key with the new API token.

4. Test each tool to confirm it connects to Atera successfully.

Once all your tools use API tokens, no further action is needed. The legacy API key stops working automatically on December 10, 2026.

PSAtera PowerShell module

PSAtera is a community-maintained, open-source PowerShell module for the Atera API, and it supports API tokens. To switch PSAtera from a legacy API key to an API token, replace your legacy API key with your new API token wherever you set it, either with Set-AteraAPIKey or in the ATERAAPIKEY environment variable. No script changes are needed, because PSAtera detects the token format and authenticates automatically.

Note: PSAtera is not developed or maintained by Atera, and Atera Support can’t help with installing, configuring, or troubleshooting it. For issues with the module, see the PSAtera GitHub repository.

Use case

In this use case, we will request a list of agents for a specified machine and delete a specified agent. It will help you understand how to interact with Atera's API and how requests are structured.

To return a list of agents for a specified machine and delete an agent:

1. On the left-side panel of the Atera API documentation page, you can see all available domains and their corresponding endpoints:

2. Click Get agents for specified machine to jump to the relevant section.

3. Enter the machine name in the mandatory field machineName and click Try.

The Response body shows a list of agents and their associated details for the machine you entered.

4. Copy the value from the AgentID field.

5. Click Delete specified agent on the left-side panel to jump to the relevant section.

Warning: The next step runs a real request on your account and deletes the agent. This can't be undone. Only use an agent you intend to remove.

6. Enter the ID of the agent you want to delete in the mandatory field agentId and click Try.

The Response body shows whether your request was successful.

The Response Status code appears above the Response body, and its corresponding status is displayed in the Response section below the Response body.