API FAQ

API, an acronym for Application Programming Interface, refers to a mechanism through which different software components interact. In this context, "Application" encompasses any software with specific functionality, while "Interface" can be understood as a service agreement between two applications. This agreement outlines the protocols for their communication, involving requests and responses.

Important Note: Please be advised that Atera support does not offer assistance for creating or troubleshooting API connections.

Frequently asked questions

This section will cover the frequently asked questions regarding the Atera API.

Q: What is an API?

A: An application programming interface, often referred to as an API, serves as a means for multiple computer programs to exchange information and interact. Essentially, it functions as a software interface that provides a service to other software components.

Q: Does Atera have an API?

A: Yes, Atera provides an API, enabling you to integrate various components of Atera with other software applications.

Q: What is the cost of API integration?

A: The API module in Atera is included as part of your subscription at no additional cost. However, it's important to note that during the trial period, API access is not available.

Q: What can be achieved using the API provided by Atera?

A: With Atera's API, you can seamlessly integrate Atera with various applications, like WhatsApp, Slack, and Teams. This integration opens up opportunities for practical applications, such as automating ticket creation in Atera directly from these mentioned platforms, and receiving alert or ticket notifications in WhatsApp, Slack, and Teams when events occur within Atera. Furthermore, the API allows you to extract agent, ticket, and alert information to create your custom dashboard, suitable for display on a TV in your office. The API also provides the capability to establish a web form on your website, enabling customers to directly generate tickets in Atera. The range of possibilities using Atera's API is extensive and adaptable.

Q: Can any software application be integrated through the API?

A: No, for integration with Atera, the other software application must also have its own API.

Q: Is developer knowledge necessary to integrate Atera with other software applications via the API?

A: Yes, to achieve a successful API integration, a foundational knowledge of programming languages such as JavaScript or Python is essential. Additionally, a strong grasp of HTTP/HTTPS and RESTful design principles is required.

Q: Which API tool and version does Atera utilize?

A: Atera employs Swagger V3 to drive its API.

Q: What are the purposes of different types of requests, such as GET, POST, DELETE, and PUT?

A: Each type of request serves a distinct function:

• GET is employed to retrieve information from the components available in the API. For instance, you can use GET to extract agent information and generate reports about your agents.

• POST is used to input data into your Atera instance. For example, the POST option in the ticket section is utilized to create new tickets within Atera.

• PUT serves a similar purpose to POST, as it is also used to add data to your Atera instance. However, the key difference is that PUT is employed to update existing entries, whereas POST is used to create new ones.

• DELETE as the name suggests, is used to remove a specific entry within your Atera instance.

Q: What data can be accessed or added to Atera via the API?

A: The API offers various functionalities across different components of Atera:

• Agents: The API allows you to GET or DELETE data related to your Windows, Mac, and Linux agents.

• Alerts: Using the API, you can perform GET, POST, and DELETE operations on alert information within your Atera instance.

• Billing: You can use the API to GET information about your invoices within Atera.

• Contacts: The API provides options for GET, POST, PUT, and DELETE operations on contacts within your Atera environment.

• Contracts: You can obtain information about your contracts using the API.

• Customer: For customer information, you have comprehensive control via the API, including GET, POST, PUT, and DELETE operations.

• Custom Values: With this functionality, you can GET or PUT data concerning your custom fields within your Atera instance.

• Device: You can GET, POST, or PUT monitoring devices, including SNMP, TCP, HTTP, and Generic devices. The POST option enables you to create monitoring devices directly from the API, facilitating imports from other software applications.

• Knowledge Base: The API permits you to GET information from your knowledge articles, allowing you to have a copy of your knowledge base on an internal website.

• Rates: You can manage your contract rates using the API, with options for GET, POST, PUT, or DELETE.

• Tickets: All request types are available for ticket-related operations: GET, POST, PUT, or DELETE. This section can be used to retrieve ticket information, create new tickets, update existing tickets, or delete them.

Q: Can I define my own API requests or actions to work with data beyond the ones mentioned earlier?

A: No, customization of the API is not supported. The available API calls and requests are limited to those listed in the previous question.

Q: Are there any articles that demonstrate how to use the API?

A: Yes, for detailed information on utilizing Atera's API, please refer to the following article.

• APIs

Q: Is there a restriction on the volume of data I can manage through the Atera API?

A: Yes, there is a limit on the number of requests per minute based on your subscription. For the lowest-tier subscription, the limit is set at 400 requests per minute, while the highest-tier subscription allows for more requests per minute. It's crucial to also consider any API limitations inherent to the software application you intend to integrate with the Atera API.