Skip to main content

API & Integrations

Tips on using API with Automox

  • 51 Topics
  • 190 Replies
51 Topics
CallmePH
CallmePHPro
asked in API & Integrations
Status page question

With the new (and awesome btw) Status page roll out, is there a way to api pull from that page? Just looking for base info... up,degraded,down and the like! I looked a bit to see if I could find that but coming up empty lol!

60
CallmePH
T
theITGuy1969Rookie
posted in API & Integrations
Deleting Duplicate Devices with API and Powershell

Reached out to support and they said they didnt have a way to bulk remove duplicate devices . They have this link but its a little lacking. https://developer.automox.com/openapi/axconsole/operation/deleteDevice/ With Chat GPT and a little trouble shooting, i came up with this powershell script that worked for me.  you will need to do an export of all devices, find the duplicates and get a list of device id’s and put them in column A with deviceid as the header, save as *.csv.  Enjoy! #Add api key and orgid!$apiKey = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'$orgId = xxxxxx$headers = @{       "Authorization" = "Bearer $apiKey"      "Content-Type"  = "application/json"      }#Edit csv path and log path!# Paths$csvPath = "C:\Path\*.csv"$logPath = "C:\Path\*.txt"# Clear previous logif (Test-Path $logPath) {    Remove-Item $logPath}New-Item -Path $logPath -ItemType File -Force | Out-Null# Read device IDs$deviceIds = Import-Csv -Path $csvPathforeach ($row in $deviceIds) {    $deviceId = $row.Dev

320
T
P
Paolo AndradeRookie
asked in API & Integrations
Azure Policy - Bulk deploy Agent if it doesn't exist

Hello Automox Community1Has anyone been able to deploy the agent using Azure Policy? I understand going the gold image route is the typical way. But I’d like to have other options of automating the Agent deployment if it’s missing on an Azure server VM.

463
P
T
tonywRookie
posted in API & Integrations
Use API to Run a Needs Attention Report

# Set mandatory variables$apiKey = 'Your_API_Key'$orgID = 'Your_OrgID'# Set optional$groupID = ''# Where to save the file$currentDate = (Get-Date).ToString("yyyyMMdd")$output = "C:\Temp\NeedsAttention$currentDate.txt"################################################## $headers = @{ "Authorization" = "Bearer $apiKey" }If ($groupID){ $url = "https://console.automox.com/api/reports/needs-attention?o=$orgID&groupId=$groupID"}else{ $url = "https://console.automox.com/api/reports/needs-attention?o=$orgID"}$response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers).Content$data = $response | ConvertFrom-Json# Extract the devices information$devices = $data.nonCompliant.devices# Create a table and format the output$table = @()foreach ($device in $devices) { $table += [PSCustomObject]@{ ID = $device.id Name = $device.name CustomName = $device.customName Created = (Get-Dat

601
A
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

2294
K
V
villagegybeRookie
asked in API & Integrations
Error using Automox Custom API Dashboard through PowerBI

Hello, I am trying to follow the Automox/PowerBi guide here: https://help.automox.com/hc/en-us/articles/8180172309780-Custom-API-Dashboard-through-PowerBI#h_01HAT7WZ8E95S0YA6E8FCYVY5B but running into an issue on step #6 (Double click to open Automox_Reports_Example_v1_wAPI.pbit from C:\temp\.). When I do this, PowerBI states “query is blocked by the following errors: health, The column 'name' of the table wasn't found.”  Due to this, all the PowerBI report pages are blank as the rest of the queries don’t load. When opening up health.csv, I see that it is empty.  Any thoughts? 

795
K
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 

3208
Marshyp
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

64918
D
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.

173811
S
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'

12034
L
jbh
jbh
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?

1861
0
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:  

223217
E
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.

1020
I
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

2741
S
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

200017
BrandonG-Automox
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 May 1, 2025 to account for Fast by Default# https://developer.automox.com/developer-portal/servers-fast-by-default# 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

192216
A
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  

2310
M
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. 

2140
S
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 

2543
M
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.  

3661
BrandonG-Automox
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

1660
Carson
jbh
jbh
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?

4564
jbh
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?

20127
jack.smith
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.

4752
jack.smith
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 -

7791
D
Terms & ConditionsCookie settings