Skip to main content

API & Integrations

Tips on using API with Automox

  • 46 Topics
  • 178 Replies
46 Topics
Tony-Automox
Tony-AutomoxAutomox Employee
posted in API & Integrations
Use API to List All Systems That Have or Need a Particular CVE Installed

You’ll need to set the following before running the script: $apiKey = 'YOUR_API_KEY' - in your console, go to Settings->API and select the API key. Note that the API key is per admin user, so you and another admin in your console will have different API keys. $orgID = 'YOUR_ORG_ID' - put in your Org ID which can be found by looking at the URL on the dashboard and selecting the value after the “?o=”: [https://console.automox.com/dashboard?o=1234]. In this example the Org ID is 1234. $cve = 'DESIRED_CVE' - Set the CVE You can also modify $filepath if you want to change the file name or save it in a different location. Keep in mind the script will overwrite a previously generated file if it exists. # Set these ----------------- $apiKey = 'YOUR_API_KEY' $orgID = 'YOUR_ORG_ID' $cve = 'CVE-2020-0689' $filepath = 'C:\Temp\cve.csv' # --------------------------- $page = 0 $limit = 500 $servers = @() $apiInstance = 'https://console.automox.com/api/' $apiTable = 'servers' Set-Content $fil

61818
D
30 days ago
A
ArcherFXNovice
asked in API & Integrations
USE API to get all software and what Automox can patch and not patch

I am looking for a PS script to get a list of all software installed in our environment and determine which ones Automox can patch and which ones cannot be patched by Automox. Thanks 

2957
L
9 months ago
Tony-Automox
Tony-AutomoxAutomox Employee
posted in API & Integrations
Use API to Determine if a Certain Software is Installed on All Devices

This was originally written for a customer that wanted to see if every system in their environment had Sophos Antivirus installed or not - and what version if they did. $apiKey = 'YOUR_API_KEY' - in your console, go to Settings->API and select the API key. Note that the API key is per admin user, so you and another admin in your console will have different API keys. $orgID = 'YOUR_ORG_ID' - put in your Org ID which can be found by looking at the URL on the dashboard and selecting the value after the “?o=”: [https://console.automox.com/dashboard?o=1234]. In this example the Org ID is 1234. $appInstalled = 'APPLICATION' - put the name of the application as it is listed in the software section of a device’s page that has it installed. $filepath - The save location and file name for the .csv file generated. Here’s a sample output checking for Microsoft Edge Chromium: $apiKey = 'YOUR_API_KEY' $orgID = 'YOUR_ORG_ID' $appInstalled = 'Microsoft Edge' $filepath = 'C:\Temp\AppInstalled.

160111
S
10 months ago
Tony-Automox
Tony-AutomoxAutomox Employee
posted in API & Integrations
Use API to Get a Hardware Inventory of Your Organization

This API script will give you a hardware inventory in addition to some basic OS info and agent version. You’ll need to set the following before running the script: $apiKey = 'YOUR_API_KEY' - in your console, go to Settings->API and select the API key. Note that the API key is per admin user, so you and another admin in your console will have different API keys. $orgID = 'YOUR_ORG_ID' - put in your Org ID which can be found by looking at the URL on the dashboard and selecting the value after the “?o=”: [https://console.automox.com/dashboard?o=1234]. In this example, the Org ID is 1234. You can also modify $filepath if you want to change the file name or save it in a different location. Keep in mind the script will overwrite a previously generated file if it exists. # Update these variables with your API Key, orgID & save directory/filename # This script expects the $expDir path to already exist and will overwrite an existing file $apiKey = 'YOUR_API_KEY' $orgID = 'YOUR_ORG_ID'

10954
L
10 months ago
jbh
jbhPro
posted in API & Integrations
Any chance Automox is going to create a Terraform provider?

We already use the Automox API quite a bit, but it would be nice to have an Automox provider for Terraform.  Any chance of that happening anytime soon?

1561
0
1 year ago
Tony-Automox
Tony-AutomoxAutomox Employee
posted in API & Integrations
Use API to Pull Software Inventory for Every Computer in an Organization

Using the standard API call for software packages installed will just give you software installed on a single device referenced by the server ID#. This script will give you software packages installed on every device in an organization referenced by the computer names. By altering the script you can add additional fields - but make sure the Set-Content line reflects all of the fields you add to the Select-Object part of the last line of the script. You’ll also want the Set-Content line to have the fields in the same order as the Select-Object. Available fields can be found here from the Response tab:https://developer.automox.com/openapi/axconsole/operation/getDevicePackages/ View the script on GitHub You can also modify it to do things like not show Windows updates & hotfixes by altering the Where-Object part of the last line of the script. For example:Where-Object {$.installed -EQ $true -and $.repo -notlike “Windows*”}  You’ll need to set the following before running the script:  

200617
E
1 year ago
Tony-Automox
Tony-AutomoxAutomox Employee
posted in API & Integrations
Use API to Pull a List of All Outstanding Critical Updates and the Age of the Update

This script will dump all available critical updates for all of the endpoints in an organization into a .csv file along with the number of days the update has been available and if the update requires a reboot. You’ll need to set the following before running the script: $apiKey = 'YOUR_API_KEY' - in your console, go to Settings->API and select the API key. Note that the API key is per admin user, so you and another admin in your console will have different API keys. $orgID = 'YOUR_ORG_ID' - put in your Org ID which can be found by looking at the URL on the dashboard and selecting the value after the “?o=”: [https://console.automox.com/dashboard?o=1234]. In this example the Org ID is 1234. You can also modify $filepath if you want to change the file name or save it in a different location. Keep in mind the script will overwrite a previously generated file if it exists. $apiKey = 'YOUR_API_KEY' $orgID = 'YOUR_ORG_ID' $filepath = 'C:\Temp\CritUpdates.csv' Set-Content $filepath -Value

1662
A
1 year ago
I
ihloom_ejRookie
posted in API & Integrations
Create a RBAC in which you can define a user access to only specific groups

The overall structure of zones vs. groups is creating a lot of redundant issues. As a service provider, we have many clients, which means a lot of consistent policies and users being made. Having clients in zones, we can assign their users the ability to view their console. But then we have to duplicate the same policies, worklets, and users from one zone to another. This is really redundant and the overall structure of zones vs. groups just makes API calls for all clients a nightmare. I see that you can customize the Automox agent installer to specify a group. Managing by the zone (top-level) and groups (clients) makes everything easier to manage. Only thing missing is limiting a user to view only specified group(s). Is there a possibility of this being added in the future? It is just very odd that there is limited to no features when administrating on a global level.

910
I
1 year ago
Nic-Automox
Nic-AutomoxFormer Automox Employee
posted in API & Integrations
Dynamic Groups Worklet Workaround API Script (runs multiple RSP & worklet policies against a list of devices)

This script will let you run an arbitrary number of required software policies or worklets against a list of devices exported from the Devices page, in essence giving you a workaround to implement a dynamic group functionality. Go to your devices page and filter for the devices you’d like to run the policies against. Click the select all box to select all of those devices. Click Export which will save a csv file that contains one line per device, named automox-devices.csv. Replace YOUR_API_Key with a valid API key from your console. Replace YOUR_ORG_ID with the orgID for your console (you can get this from the browser URL for your console: look for the o=1234 portion and that 1234 is your orgID). Replace PolicyID1,PolicyID2,PolicyID3,PolicyID4,PolicyID5,etc… with a list of the policies you want to run, each one separated by a comma. To find the PolicyIDs, edit the policy you wish to include and look for the pid=123456 in the URL. That 123456 is the Policy ID that you’ll put in the l

2561
S
1 year ago
Nic-Automox
Nic-AutomoxFormer Automox Employee
posted in API & Integrations
Powershell script to remove devices that have been disconnected longer than X days

A common request we get is to remove old devices from the console, especially ones that might have been re-imaged. Currently you can do this on the devices page by sorting by Last Disconnected Date and selecting devices to remove. However, this can become unwieldy if you have pages and pages of devices to remove. This script automates the removal using an API call to check the last disconnected date and remove any devices older than the number of days you specify in the code. There are four areas in the code you’ll need to update to get the script to function: $orgID = 'YOUR_ORG_ID' - put your Org ID, which can be found by looking at the URL of your console and selecting the value after the “?o=”: https://console.automox.com/dashboard?o=999999. In this example URL the Org ID is the 999999 portion. $apiKey = 'YOUR_API_KEY' - in your console, go to Settings->API and select the API key. Note that the API key is per admin user, so you and another admin in your console will have di

186717
BrandonG-Automox
1 year ago
Tony-Automox
Tony-AutomoxAutomox Employee
posted in API & Integrations
Agent Communication and Health Check Report

Based on a query by @d.mccleskey that support would have to run for customers, I’ve adapted it so that customers can run it for themselves. This query is useful for customers to review their Automox patching configurations and review agent communication/health. $apiKey = 'YOUR_API_KEY' - in your console, go to Settings->API and select the API key. Note that the API key is per admin user, so you and another admin in your console will have different API keys. $orgID = 'YOUR_ORG_ID' - put in your Org ID which can be found by looking at the URL on the dashboard and selecting the value after the “?o=”: [https://console.automox.com/dashboard?o=1234]. In this example, the Org ID is 1234. # Updated code 3/31/21 so script doesn't break if system(s) in org are missing disk volume info # Update these variables with your API Key, orgID & save directory/filename # This script expects the $expDir path to already exist and will overwrite an existing file $apiKey = 'YOUR_API_KEY' $orgID = '

172916
A
1 year ago
M
mercjoeRookie
asked in API & Integrations
Automox API and Freshservice integration

 Hi Eveyone, I’m researching whether what I’m trying to do is feasible or not. I’m trying to trigger a webhook on freshservice workflows The idea is to trigger a prepatch email when a patching ticket is placed and another one after the ticket has been completed.  Question is. Is there a way to trigger a prepatch report and send it through mail by using the automox API ? so far I couldn’t find a way to do it.   Thanks for any helpDiego  

2020
M
2 years ago
S
stevewarRookie
asked in API & Integrations
How to notify users patching is complete?

Hello everyone, One of the most consistent pieces of feedback I get from users is that they don’t know when it is safe to press the Install Now button on the patching notification. The primary reason is due to silent installs, they have no idea when it is safe to “get back to work.”The Automox UI clearly has this status in the device details screen, as it displays installing, and once the installation is complete, the device returns to ready status.  I searched the API, but I can’t find any method of accessing this status such that I can display a complete message to users. 

1990
S
2 years ago
M
mercjoeRookie
asked in API & Integrations
API authentication

 Hi EveryoneI’m new to the API.  guess im doing something wrong related to authentication. I can query through postman without any issues using my key but no luck with the below code : Here is what Im tryin to run through PS but I always get an “(401) Unauthorized.” error message$headers=@{Authorization="MyAccessKeyStringhere";Content='application/json'}$uri = "https://console.automox.com/api/reports/prepatch"$result = Invoke-restmethod -Uri $uri -Headers $headers -method get$result  | select -expandproperty profile |select name  Thanks a lot for any help. Diego 

2333
M
2 years ago
I
IvanRookie
asked in API & Integrations
Having issues connecting PowerBI to Automox API

I am trying to get powerBi to pull data from:https://api.wifisensorcloud.com/I have been going over all the api documentation and reviewing powerbi support forums and I cannot get powerbi to pull the JSONThe supplier have given me the API Key, but I get the following error: “A web API key can only be specified when a web API key name is provided”BELOW ARE THE INFORMATION FROM SUPPLIERConnecting to the API The 5 services are hosted at:https://api.wifisensorcloud.com/Users.svchttps://api.wifisensorcloud.com/Locations.svchttps://api.wifisensorcloud.com/Devices.svchttps://api.wifisensorcloud.com/Sessions.svchttps://api.wifisensorcloud.com/Lookups.svcConnections using any protocol other than https (such as http) will be rejected. Requests for data should use the GET method with parameters supplied in a query string whereas data submissions/updates should use the POST method with parameters supplied in a JSON object. Examples of each of these methods are on the next pages.  

3521
BrandonG-Automox
2 years ago
Carson
CarsonRookie
posted in API & Integrations
Error in API documentation for "List All Devices"

I think I have found an error in the PowerShell request sample from the documentation for Automox’s "List All Devices" API call.  The request sample has:$url = "https://console.automox.com/api/servers?o=:orgID&page=0&limit=500"This did not run until I changed :orgID to $orgID in order to reference my Organization ID.Actually, I now see that the sample does not include a definition of $orgID either.  So, altogether IMO the sample should read,$apiKey = 'your_automox_api_key'$orgID = ‘your organization ID’$headers = @{ "Authorization" = "Bearer $apiKey" }$url = "https://console.automox.com/api/servers?o=$orgID&page=0&limit=500"$response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers).ContentI raise this issue because the PowerShell error resulting from the sample isn’t very specific.  Due to that, and because I am only beginning to use this API, it took me quite awhile to discover that the sample was incorrect as opposed to my having made a mistake.  Therefor

1530
Carson
2 years ago
jbh
jbhPro
asked in API & Integrations
How to bulk add devices to groups

If this doesn’t belong in the “Labs” portion, I apologize in advance. I’m migrating devices from one Zone to new Zones.  I think I’ve got that process mostly down, but am now looking for the best way to use the API to read in a csv file with the new devices and join them to a new group in the new Zone. Do we have something like that, that I can use?

4114
jbh
2 years ago
D
DaneRookie
posted in API & Integrations
Having issues connecting PowerBI to Automox API

I am trying to get powerBi to pull data from: https://console.automox.com/api/servers I have been going over all the api documentation and reviewing powerbi support forums and I cannot get powerbi to pull the JSON I get the following error: A web API key can only be specified when a web API key name is provided I have tried using the API key as a username, doesn’t appear to work there either. Has anyone gotten PowerBi to successfully pull data from the Automox web api, and how did you do it?

19447
jack.smith
2 years ago
K
kido1991Rookie
asked in API & Integrations
API Endpoint for Activity Log and Overview Report

Hi,Is there any endpoint or anyway that we can pull the data of Activity Log and Overview Report using the API yet?Thank you.

4532
jack.smith
2 years ago
Nic-Automox
Nic-AutomoxFormer Automox Employee
posted in API & Integrations
Example of API call with pagination limits

I’ve taken @jarod.smilkstein’s code from here. There’s 3 things to change in this code to make it work:    put in your API key put in your orgID set the $limit variable to the size you want, with a maximum of 500    This code will pull down all your device info via the https://console.automox.com/api/serversAPI call, but you can sub that out for whatever info you’re wanting to pull. The data is saved to a csv, but you can also do manipulation to the $data object in the script first before outputting any data.  You can use this example code to update any of your existing scripts that were created prior to the API limits.  $apiKey = 'YOUR_API_KEY'$orgID = 'YOUR_ORG_ID'$page = 0$limit = 5$data = @()while($true) { $uri = "https://console.automox.com/api/servers?o=$orgID&api_key=$apiKey&l=$limit&p=$page" $resp = (Invoke-WebRequest -Method GET -Uri $uri -UseBasicParsing).Content | ConvertFrom-Json | Select-Object results $data += $resp.results if($resp.results.count -

6691
D
2 years ago
D
David_MitchellNovice
posted in API & Integrations
Use API to run multiple policies on device by name

I created a fun and friendly API script to run multiple policies on a device by using device name and policy names. You can customize it so that $Policylist is a parameter if you like and execute different policies as needed. Even though I am only executing on one device, I scripted it to pull all device names and ID’s so that I can customize it to run on a list of devices if we need to. Pieces of this script were used from many different posts here as well as the KB. Thanks to all that posted and shared with the group. I think this brings a lot of it together and gives some flexibility to automate just about whatever needs automating. Enjoy. ####Process Params #### Example .\baseimage.ps1 -DeviceName "tec006" -apiKey "xxxxx-xxxxx-xxxxxxx" param ([String]$DeviceName, [String]$apiKey) #### List of software to install as base image $Policylist = "Apply Dell Driver Updates","Install Sophos", "Install Mozilla Firefox", "Install Google Chrome", "Install Adobe Reader", "Install EgnyteWebE

4392
D
2 years ago
ScottS-Automox
ScottS-AutomoxAutomox Employee
posted in API & Integrations
Initiating a policy programmatically using the /policies/{id}/action endpoint

Initiating a policy programmatically can be a power tool to help you automate your patching program with Automox APIs.  If this is something that you’re currently doing or would like to start, please see our updated documentation in our developer portal below:  https://developer.automox.com/openapi/axconsole/operation/executePolicy/ Please take special care to ensure that you are using the request body schema to identify the required action parameter of “remediateAll” “remediateServer”.  These commands will make use of all the configurations made by the administrator that created the policy including patching notifications, reboot notifications and deferrals.  As always, let us know if you have any questions!

2181
A
2 years ago
Peter-Automox
Peter-AutomoxAutomox Employee
published in API & Integrations
Automox API Overview

Introduction What is an API, anyways? Where do I Start?  What are the Security Considerations? Does Automox have a Software Development Kit (SDK)? ConclusionIntroductionThe 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 anyth

6220
Peter-Automox
2 years ago
Peter-Automox
Peter-AutomoxAutomox Employee
published in API & Integrations
How to Use the Automox Developer Portal

Introduction  How is the Documentation Organized? How do I use the API Documentation? Can I Submit a Call from the Developer Portal? Conclusion Introduction A feature or set of features is only useful if you know how to use it. That’s why we place so much emphasis on our Support documentation at Automox, from User Guides to Knowledge Base, to our Developer Portal. Within the Developer Portal lives our API documentation. To help you harness the full power of the documentation and our API, we’ll review how to get the most out of the Developer Portal.  How is the Documentation Organized?First thing’s first, you need to know how to get to the Developer Portal. If you’re planning to use the API frequently, just bookmark this page.At a high level, our API documentation is laid out like this: What’s New: this is where we meticulously document anything/everything new with the API and our API documentation Errors: this page provides a high level overview of errors you may run into throughout

3010
Peter-Automox
2 years ago
Tony-Automox
Tony-AutomoxAutomox Employee
posted in API & Integrations
Delete Multiple Users From An Organization

This API script will delete multiple users from an organization based on the users’ email address. It will then log the successes and failures in a location you specify. Just set the following: $apiKey = 'YOUR_API_KEY' - in your console, click on the three dots in the upper right, select KEYS, then copy your API key. Note that the API key is per admin user, so you and another admin in your console will have different API keys. $orgID = 'YOUR_ORG_ID' - put your Org ID which can be found by looking at the URL from any Automox page and selecting the value after the “?o=”: [https://console.automox.com/device-detail?s=99999&o=1234 ]. In this example the Org ID is 1234. $logPath - set where you want the logs saved $toDelete - set your list of users you want deleted by their email addresses ### Replace the variables in this block with your Org ID & API key ### $orgID = 'YOUR_ORG_ID' $apiKey = 'YOUR_API_KEY' # Modify log path as desired $logPath = 'C:\Temp\' # List of users identifi

1991
A
2 years ago
Terms & ConditionsCookie settings