Introduction
The Automox API gives your organization a framework to leverage the powerful data within Automox, and take action without interacting with the console. In this article, we’ll discuss the API at a high level, and what resources are available for you to get started.
What is an API, anyways?
An Application Programming Interface (API) is a set of protocols and definitions that allow an application to communicate with other applications. Essentially, it’s a way for you to make Automox execute an action (e.g. create a policy), integrate Automox with another application your organization uses, or automate a process, all without using the console.
Automox is a cloud-native application, and we built our console on top of the RESTful (or REST) API. Since our user interface, or console, is built on top of the API, you can do anything with the API that you can do in the console.
Where do I Start?
If you’re not sure where to start with the API, head over to the Automox Developer Portal. Our developer portal is filled with rich documentation detailing each API action, request samples for PowerShell, curl, JavaScript, etc. and response samples. We update this documentation regularly, so bookmark the site if you plan to use the API.
If you haven’t used an API before, start here. We’ll guide you through the process, and how you can make your own API calls with Postman.
What are the Security Considerations?
In order to use our API, you need to create an API key in the console. The API key allows you to access the API to make calls (execute an action, get data, etc.) to your organization.
With great power comes great responsibility.
Remember, if someone gains access to your API key, they have free rein over your organization’s Automox data. They could execute actions, such as create a Worklet to install malware against your organization.
Always practice good API security; do not create more API keys than you absolutely need, do not embed API keys directly in code, and do not store API keys in files within your application source tree.
For more information on managing your organization’s API keys, visit our support page.
Does Automox have a Software Development Kit (SDK)?
In addition to our API, we also have a powerful Python-based SDK to provide you with the tools to create applications with pre-built and maintained library components as well as example use cases. For more information on our SDK and link to download, visit our SDK page in the Automox developer portal.
Conclusion
The Automox API provides a powerful framework to integrate with Automox, so that you can leverage the full power of your data and the Automox platform. Treat your API key(s) with the utmost caution, and only provision a key when absolutely necessary. In the wrong hands, API keys can allow a threat actor to affect any change they’d like to on your Automox data (endpoints, policies, etc.).