Answers to common questions about the Atera API, including API tokens, the legacy API key deprecation on December 10, 2026, authentication, rate limits, cost, available data, and troubleshooting failed API requests. For step-by-step instructions, see Using the Atera API.
Important: Atera Support doesn't offer assistance with creating or troubleshooting API connections.
Frequently asked questions
What happens to my legacy API key?
Legacy API keys stop working on December 10, 2026, and any integration or script still using one will fail. Since November 10, 2026, the legacy API key page is no longer available in Atera and new legacy keys can't be created, but existing legacy keys keep working until December 10. To keep your integrations running, an admin needs to create an API token and replace the legacy API key with it in each tool. For the steps, see Update third-party tools to use an API token.
How do I authenticate with the Atera API?
Authentication is done using an API token. Only admins can create API tokens, under Admin > Data management > API. Send API requests to https://api.atera.com and include the token in the Authorization header using the Bearer scheme, for example: Authorization: Bearer {token}. For the steps, see Authenticate with an API token.
What is the cost of the Atera API?
The Atera API is included in your subscription at no additional cost. API access isn't available during the trial period.
What is an API, and does Atera have one?
An application programming interface (API) is a way for software applications to exchange information and interact through requests and responses. Atera provides an API that lets you integrate Atera with other software applications.
What can I do with the Atera API?
With the Atera API, you can integrate Atera with other applications, such as WhatsApp, Slack, and Teams. For example, you can create tickets in Atera directly from these platforms, or receive alert and ticket notifications in them when events occur in Atera. You can also extract agent, ticket, and alert information to build a custom dashboard, or set up a web form on your website that lets customers create tickets in Atera directly.
What data can be accessed or added to Atera via the API?
The API supports the following operations for each domain:
- Agent: GET or DELETE data related to your Windows, Mac, and Linux agents.
- Alert: GET, POST, and DELETE alert information.
- Billing: GET information about your invoices.
- Contact: GET, POST, PUT, and DELETE contacts.
- Contract: Find, create, update, or delete contracts with GET, POST, PUT, and DELETE.
- Customer: GET, POST, PUT, and DELETE customer information.
- Custom Values: GET or PUT data in your custom fields.
- Department: Find, create, update, or delete departments with GET, POST, PUT, and DELETE.
- Device: GET, POST, or PUT monitoring devices, including SNMP, TCP, HTTP, and Generic devices. POST lets you create monitoring devices directly from the API, for example when importing them from other software.
- Knowledge Base: GET information from your knowledge base articles, for example to keep a copy of your knowledge base on an internal website.
- Rates: GET, POST, PUT, or DELETE your contract rates.
- Tickets: GET, POST, PUT, or DELETE tickets, to retrieve ticket information, create new tickets, update existing tickets, or delete them.
What are the purposes of GET, POST, PUT, and DELETE requests?
Each request type serves a different purpose:
- GET retrieves information. For example, use GET to extract agent information and generate reports about your agents.
- POST creates new entries. For example, use POST in the Tickets domain to create new tickets in Atera.
- PUT updates existing entries.
- DELETE removes a specific entry.
Can I define my own API requests or actions beyond the available ones?
No, customizing the API isn't supported. For the full list of available API calls, go to Admin > Data management > API > API documentation.
Can any software application be integrated through the Atera API?
No. To integrate with Atera, the other software application must also have its own API.
Do I need developer knowledge to integrate Atera with other applications via the API?
Yes. A successful API integration requires a foundational knowledge of a programming language such as JavaScript or Python, and a good understanding of HTTP/HTTPS and RESTful design principles.
Can I test API calls before implementing them?
Yes. You can test API calls on the API documentation page (Admin > Data management > API > API documentation) or with tools like Postman.
Warning: Test requests run against your live Atera account. POST, PUT, and DELETE requests change or remove real data, so test them on records you don't need.
Can Atera provide a direct export of full ticket comments and email history, or increase API rate limits for backups?
No. Atera can't provide a direct export or a backend copy of full ticket comments and email history. The API is the only supported method for retrieving complete ticket data, including full comment chains and email history.
To back up or export full ticket and comment data, work within the API's existing rate limits. We recommend that you:
- Batch your API requests.
- Add delays or throttling to your scripts.
- Spread the export over a longer period to avoid failures.
- Use incremental (delta) sync instead of pulling full lists each time. Save the timestamp of your last successful pull and request only records changed since then: for tickets, use the tickets lastmodified endpoint; for contacts and customers, use the FromLastModifiedDate filter.
What should I do if my API requests fail?
If a request fails, check the following:
- You're using an API token, not a legacy API key. Legacy API keys stop working on December 10, 2026.
- Your API token is valid, hasn't expired, and is included in the Authorization header. The token must also have permission for the domain you're calling (for example, Read permission for Agents). If the token is limited to specific IP addresses, the request must come from one of them.
- The endpoint URL and method (GET, POST, PUT, DELETE) are correct.
- Your request body uses valid JSON.
- If you receive a 429 Too Many Requests response, you've exceeded your account's rate limit. Wait the number of seconds shown in the Retry-After header before retrying, and back off further on repeated 429 responses.
If issues persist, review the error message in the response body or check the API documentation page.
Can I view API logs or monitor API activity?
Atera doesn't currently provide dedicated API logs in the platform. You can use external logging or monitoring tools to track request and response activity.
Why doesn't the number of tickets from the API lastmodified endpoint match the Timesheet Report filtered by Work Hour Date?
The two use different rules for filtering tickets:
- API lastmodified endpoint: Looks at the most recent activity on each ticket. If that activity happened on or after the date you specify, the ticket is returned.
- Timesheet Report (Work Hour Date filter): Looks at when work hours were logged on a ticket. If work hours were logged within your selected date range, the ticket appears in the report.