API & Integrations

Tips on using API with Automox

46 Topics
177 Replies

I am not sure if anyone has this need (or if this has been posted before), but here’s a little Powershell script you can run with a scheduled task to delete hosts that have not reported back to Automox after xxx days. I have this configured on a server and it helps me manage the Automox licenses automatically. #Define API Key and URL to get initial Machine list $apiKey = "<insert your API key here>" $headers = @{"Authorization" = "Bearer $apiKey"} $lengthPerPage = 100 $pageCounter = 0 $maxItems = 0 $maxDays = 30 do { $apiUrl = "https://console.automox.com/api/servers?l=$lengthPerPage&p=$pageCounter" $response = Invoke-RestMethod $apiUrl -Method 'GET' -Headers $headers -Body $body $a = $response | ConvertTo-Json $maxItems = $response.results.count $currentItem = 0 foreach($server in $response.results) { $lastCheckin = Get-Date if ($server.last_disconnect_time) { $lastCheckin = [datetime]$server.last_disconnect_time }

3 years ago

Tony-AutomoxAutomox Employee

posted in API & Integrations

Use API for a Count of All Software Installed in an Organization (with Pagination)

This API call will generate a list of all software in your organization and a count of how many are installed of each. Just update your API key, org ID, and where you want the file saved. It will overwrite an existing file if it exists. It also shows how you can use pagination to account for more than 500 results. $apiKey = 'YOUR_API_KEY' $orgID = 'YOUR_ORG_ID' $filepath = "C:\Temp\packages.csv" $page = 0 $limit = 500 $data = @() Write-Output "Page" while($true) { $headers = @{"Authorization" = "Bearer $apiKey" } $url = "https://console.automox.com/api/orgs/$orgID/packages?l=$limit&p=$page" $response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers).Content | ConvertFrom-Json Write-Output $page $data += $response $page += 1 if($response.count -lt $limit) { break } } $data | Group-Object display_name | Sort-Object name | Select-Object Count,name ` | Export-Csv -Path $filepath -NoTypeInformation

3 years ago

MrichardsPower User

posted in API & Integrations

API script to report software version in org?

Hi Guys, Looking for a powershell script that utilizies the API to make a report based on a software title and its versioning… for example: Show me all machines who have VMWare Workstation installed, and what version they are running. I could find a bit of this info in software tab on the AX UI, but no way to export into a nice report for executives… Thoughts? Thanks!

3 years ago

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

1 year ago

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 -

2 years ago

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.

7 months ago

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:

11 months ago

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

1 year ago

JHagstromPro

posted in API & Integrations

Script | Export all applied patches from all company machines to CSV

Hello! Thought I would share this API script I wrote that exports all applied patches on all machines to a CSV. UseCase: For audits this allows an easy way to export every single patch on a machine to prove that machines have been patched during a time period. Notes: This is meant to be run on a machine NOT through a worklet. Make sure to add in your own API Key for this to work. For a full list of objects you can pull from the API see Automox API Documentation under “Response”. This script is not perfect. If run multiple times it will keep adding to the same CSV, so make sure to either clear the CSV and save or just delete it. Powershell Code: #Set Execution policy to allow for 3rd party modules Set-ExecutionPolicy Unrestricted -Force #Define API Key and URL to get initial Machine list $apiKey = "*INSERT YOUR API KEY HERE*" $apiUrl = "https://console.automox.com/api/servers/" $headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]" $headers.Add("Authorizatio

3 years ago

rmullenNovice

posted in API & Integrations

API Issue

Hi, has anyone had any issues with the API from today? I had a script that pulled down all machines and was working fine for the last few weeks however stopped this morning with an ‘Invoke-WebRequest : The remote server returned an error: (500) Internal Server Error’. Script is (XXXX added for privacy): $apiKey = "XXXXX" $orgID = "XXXXX" $expDir = 'XXXXX' ############################################################################################################# #Pull server detail by group from API and export as csv to defined directory $uri = "https://console.automox.com/api/servers?o=$orgID&api_key=$apiKey&l=1100" (Invoke-WebRequest -Method -Uri $uri).Content | ConvertFrom-Json | Select-Object results -ExpandProperty results| Select-Object name, serial_number | Export-Csv -Path $expDir\AutomoxAPI_Export.csv -NoTypeInformation -Force If I remove the ‘&l=1100’ from the uri variable it works without issue, however only pulls 500 devices. This only started happening from

3 years ago

Tony-AutomoxAutomox Employee

posted in API & Integrations

API: Locate GUID for package to use InstallUpdate command in "Issue a Command to a Device"

If trying to use the InstallUpdate command to “Issue a Command to a Device”, you’ll see that it wants a GUID for the update: https://docs.automox.com/api/endpoints/issue-a-command-to-a-device So that you don’t have to comb through the registry trying to find it, you can run this script on a device that has the update installed to find the GUID so that you can use it to install it on other devices with API: $UninstallKeys = "HKLM:\Software\Microsoft\Windows\CurrentVersion\Uninstall", "HKLM:\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall" $null = New-PSDrive -Name HKU -PSProvider Registry -Root Registry::HKEY_USERS $UninstallKeys += Get-ChildItem HKU: -ErrorAction SilentlyContinue | Where-Object { $_.Name -match 'S-\d-\d+-(\d+-){1,14}\d+$' } | ForEach-Object { "HKU:\$($_.PSChildName)\Software\Microsoft\Windows\CurrentVersion\Uninstall" } if (-not $UninstallKeys) { Write-Verbose -Message 'No software registry keys found' } else { foreach ($UninstallKey in $Uninst

3 years ago

Tony-AutomoxAutomox Employee

posted in API & Integrations

Set Tags for All Computers in a Group

This script will set the tag(s) for all computers in a group. It will override any tags that are currently assigned to any of those systems. There are some 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 different API keys. $grpID = 'GROUP_ID_OF_SYSTEMS_TO_TAG' - put your Group ID of the systems you want to set the tags on. It can be found by viewing the group page that lists devices in that particular group and grabbing the value after “gid=” in the URL. One way to get to that page is to go to the System Mgmt page then find the group

3 years ago

Tony-AutomoxAutomox Employee

posted in API & Integrations

Execute Multiple Policies on a Windows Machine Using API

This script will apply multiple policies from your organization to a system. Say you always apply the same five policies to a newly built system, you could use this to apply those policies with one click to your new system. This will install any policy available in your organization regardless of whether it is attached to the group the system is in or not. Make sure you’re not attempting to apply a macOS/Linux worklet or required software to a Windows device. Just set the following: $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' & $serverID = 'YOUR_SERVER_ID' - put your Org ID & Server ID which can be found by looking at the URL on the device page and selecting the value after the “?s=” & “?o=”: [https://console.automox.com/device-detail?s=99999&o=1234]. In this example the Server ID is 999

3 years ago

Tony-AutomoxAutomox Employee

posted in API & Integrations

Powershell script to move devices that have been disconnected longer than X days to a group

So you want to audit your devices that haven’t been connected for a long time, but you’re not prepared to delete them yet and just want to move them to their own group? Currently you can do this on the devices page by sorting by Last Disconnected Date and selecting devices to Assign to Group. However, this can become unwieldy if you have pages and pages of devices to move. This script automates the move using an API call to check the last disconnected date and move any devices older than the number of days you specify in the code. There are five 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 u

3 years ago

jbragdonRookie

posted in API & Integrations

Powershell: Locate and delete any nodes disconnected after specified days.

To execute - run .\CleanAutomoxDevices.psl (includes help on required paremeters) Example run MVP run: .\Clean-AutomoxDevices.ps1 Params: orgID (required) - Your Automox Org ID apiKey (required) - Your Automox API Key maxDays (optional) - Defaults to 120 days. Override with any reasonable number. apiEndpoint (optional) - What is the API endpoint to communicate with Automox? logFolder (optional) - Override log folder. Defaults to popping out a log where script is run apiTable (optional) - Override location in URI servers are found. This probably will never be used weaponize (optional) - must be set to $true if you want anything other than a test run. -verbose: All meaningful output not in the log can be brought to screen using this command. Most screen output is hidden without this param. Destrictive run: .\Clean-AutomoxDevices.ps1 -weaponize $true All parameters are position and will be acceppepted either by their location in this above list - or using -. Also supported use -verbos

3 years ago

DavidM-AutomoxFormer Automox Employee

posted in API & Integrations

Server Detail Report - Example API PowerShell Script

Here is an API PowerShell script to export your Device Name, Model, Vendor, and Serial Number into a csv. If you have tried this, you may have found it can be tricky, as the model, vendor, and serial number are stored in a nested field named detail. This script provides the expanded “detail” column data for each device by name. Example Code: #Update these variables with your API Key and orgID. This script expects the $expDir path to already exist.# $apiKey = 'YOUR_API_KEY' $orgID = 'YOUR_ORG' $expDir = 'C:\Temp' ############################################################################################################# #Pull server detail from API and export as csv to defined directory $uri = "https://console.automox.com/api/servers?o=$orgID&api_key=$apiKey" $responseJson = (Invoke-WebRequest -UseBasicParsing -Uri $uri).Content | ConvertFrom-Json $Output = $responseJson | Select-Object NAME -ExpandProperty detail | Select-Object NAME, MODEL, VENDOR, SERIAL | Export-Csv -Path

3 years ago

DavidM-AutomoxFormer Automox Employee

posted in API & Integrations

PowerShell script to start a scan from a device

Have you ever needed to run a scan from the client side? There are times when you may want to trigger a scan from the device as part of an automation rather than from the console (or waiting for the next scheduled scan to run). One example is to automatically update the Automox inventory when a Windows 10 in-place upgrade successfully completes. Luckily, @Nic recently published a topic to clean up inactive devices (Powershell script to remove devices that have been disconnected longer than X days) that I was able to repurpose to manage this task. Thank you @Nic! This script leverages the API to identify the local device, and then sends a secondary API call to schedule a scan for itself (Pretty handy, right?). There are two 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 1. In

4 years ago

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

1 year ago

jagmeet.sidhuRookie

posted in API & Integrations

Revive dead agents - Mac OS

Hello there, Recently we discovered that we had numerous agents going offline randomly in Automox and we wanted to find a way to try to revive those endpoints remotely without having the team on the ground go to each endpoint individually. We have another service running on our endpoints that could also run Powershell/Bash scripts depending on OS and would run similarly as SYSTEM/Root user. We made use of this and came up with a script so that endpoints that were still online via this service and not in Automox could be fixed remotely. We’ve seen it work pretty successful thus far and wanted to share in case you might have need of it too. You could also run this script locally too to revive if you don’t have another service. All you need to change in the script is the cURL (with Access Key) which you can retrieve from Automox console. UPDATE: 15th Feb 2020. Added 2 additional functions to check if the service is running and whether there has been an established TCP connection by the ag

4 years ago

Nic-AutomoxFormer Automox Employee

posted in API & Integrations

Newbie's guide to getting started with the Automox API

If you’ve never used an API before and want Automox to be your first (you always remember your first API) then this is the guide for you. By the end of this document you’ll have made your first API call and can see the results from your environment. Step 1: Download Postman Postman is a handy tool for testing out API calls to make sure they work before putting them in a script. They have a freemium version for individuals and small teams that you can download:https://www.getpostman.com/They’ve got versions for Windows, Mac and Linux so it doesn’t matter what OS you are working on. Install Postman and create yourself a login and you’re ready for the next step. Step 2: Find your API key in the console In your Automox console, click on Settings and then API: You’ll want the API key (the one on the bottom). There’s a handy copy icon to the right of the API key to get it into your clipboard. Step 3: Create your first API call For this exercise, we’re going to use the “Retrieve deta

3 years ago

cfriebergNovice

posted in API & Integrations

Share Your Automox API Experience

Disclaimer: I’ve never really utilized API keys for data requests until now. My API Use Case: Collect all server OS details including policies, users, and groups. This is a great tool if you want detailed data from your Automox environment! After reviewing the API Documentation for Automox I learned the types of API commands I could run and quickly realized I needed a way easily understand what’s in a .json file and how to read it. I haven’t work with a .json file before, but after some research I found Postman which allowed me to run API requests from and easily download a .json - which ended up converting to an excel spreadsheet. The spreadsheet is so well organized and now I can easily vlookup what I need on a smaller separate work task. It was an interesting first experience using an API key and Get requests but I felt it was successful in collecting everything I needed. I’m sure others could do this type of work in their sleep but it’s another wrench in the toolbox for me. Anyon

4 years ago

Page 2 / 2

API & Integrations

Sign up

Login to the community

Scanning file for viruses.

This file cannot be downloaded