The Atera API offers multiple methods for extending Atera’s functionality. Use our API to easily integrate with external tools, streamline workflows, and automate processes. To access and interact with the API, you'll need an authentication token. You can create multiple tokens with different configurations to manage access across different use cases.

Note: 

• Atera supports API requests over HTTPS only.
• Atera's API uses MSP terminology, which may differ from IT Department terms. Learn more

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. You can create multiple tokens with different configurations to manage access across different use cases and environments.

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.

Note: You'll need to copy and store this token before closing the panel as it won't be shown again. You'll have to provide this token every time you authenticate on the API documentation page. Please keep it secret and safe as it exposes 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 the token you've created.

To authenticate using your API token:

1. Click 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.

Example

In this specific example, 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:

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 will show a list of agents and their associated details for the specified machine you entered.

4. Copy the reference from the AgentID field.

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

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

The Response body will display whether your request was a success.

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