Help CenterAtera’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: Atera supports API requests over HTTPS only.
This article describes:
Reveal your Atera API key
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).
Log in with your Atera API key
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. |
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.
3. Click GET /api/v3/agents.
4. Click Try It Out! Curl will generate.
The Response Body displays the agent information for each agent.
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.
3. Click GET /api/v3/customers.
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:
Note: 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
2. Click Customer.
3. Click PUT /api/v3/customers/{customerID}.
4. Enter the customerID.
5. Click anywhere within the box on the right-hand side of the page to populate the customer field.
6. Make your desired changes.
7. Click Try it out! Curl will generate.
The customer is updated. The Response Body shows which customer was updated and the Response Code shows that it was a success.
Julian Kudo