APIs – Atera Support

Atera’s API offers multiple methods of integrating and extending Atera’s functionality. Use our API to easily integrate with your accounting system, enhance your team’s productivity, and create seamless integrations.
Your account is protected by a unique API access key (REST API). You must log in with this key to use Atera's API.

Note: As of June 1st, we’ll only support API requests over HTTPS. If you haven’t done so already, please change any HTTP API implementation you may have to HTTPS for more secure communications. If you already use HTTPS, then you don’t have to do anything!

This article shows you how to reveal your Atera API key and how to log in with your Atera API key

To help you further, we'll show you examples for two GET requests as well as a PUT request:

Request agent information
Request customer information
Update a specific customer

Click here to access Atera's API Documentation Page

To reveal your API key:

1. From Admin, on the side panel, click API.

The API page appears.

3. Click the eye icon to reveal your API key.

Note: You'll need to provide this key with every request you make to Atera API. Please keep this key secret and safe as it exposes your contacts and their devices. If you need to reset your key for any reason, click Reset my API key (resetting the API key will cause any request made with the old key to fail).

To log in with your API key:

1. From Admin, on the side panel, click API.

The API page appears.

2. Click View documentation. The Atera API documentation page will open in a new tab.

3. Click Log in, on the upper, right-hand side of the page. The Available authorizations window appears.

4. Enter your API key. Then click Authorize.

The API gives you access to many types of data including:

Agents	MachineID, AgentID, DeviceGUID, FolderID, CustomerID, CustomerName, etc.
Alerts	AlertID, Code, Source, Title, Severity, Created, SnoozedEndDate, etc.
Billing	InvoiceID, InvoiceNumber, InvoiceNumberAsString, Total, Subtotal, Tax, etc.
Contacts	EndUserID, CustomerID, CustomerName, JobTitle, Email, Phone, etc.
Contracts	CustomerID, ContractName, ContractType, Active, Taxable, StartDate, etc.
Customers	CustomerID, CustomerName, CreatedOn, LastModified, Domain, Address, etc.
CustomValues	ItemID, ID, FieldName, ValueAsString, ValueAsDecimal, ValueAsBool, etc.
Device	Name, DeviceID, DeviceGuid, CustomerID, CustomerName, MntrngAgentID etc.
KnowledgeBase	KBID, KBTimestamp, KBContext, KBProduct, KBLastModified, etc.
Rates	RateID, Amount, Description, SKU, and Category.
Tickets	TicketID, TicketTitle, EndUserID, EndUserEmail, TicketResolvedDate, etc.

NOTE: The amount of RPMs (Requests Per Minute) per account you can send depends on the Atera package you have bought. If the limit is exceeded, you will get a 429 HTTP error for rate limiting.

Examples

To get the Agents list as a curl string:

1. Go to https://app.atera.com/apidocs. The Atera API page loads. If you haven't already, log in

2. Click Agent. The Agent methods drop down.

2._Click_Get_Agents.png

3. Click GET /api/v3/agents.

2.5_Click_Try_it_out_.png

4. Click Try It Out! Curl will generate.

3._Curl.png

The Response Body displays the agent information for each agent.

4._Response_Body.png

To get the Customers list as a curl string:

1. Go to https://app.atera.com/apidocs. The Atera API page loads. If you haven't already, log in

2. Click Customer.

4._Get_Customer.png

3. Click GET /api/v3/customers.

5._Customer_page_displays.png

4. Click Try It Out! Curl will generate.

The Response Body displays a list of all the customers and their associated information.

To update a customer:

In order to successfully implement this PUT method call, you'll need the customer's ID. Check out our previous example, or have a look at your URL when on the specific Customer page.

1. Go to https://app.atera.com/apidocs. The Atera API page loads. If you haven't already, log in