API & Integrations

Tips on using API with Automox

38 Topics
123 Replies

Nic-AutomoxFormer Automox Employee

posted in API & Integrations

How to post an API script

The scripts posted in here go live immediately, unlike the worklets which are reviewed first. They still get reviewed after posting to make sure the code works and isn’t malicious, but there’s a bit more caveat emptor in here since scripts require more technical knowhow to run. To share a script, click on the New Topic button and post your code and instructions for use. To format your code, use the markup of 3 backticks (```) on the lines above and below your code. Then it will look like this: Write-Host "Hello, World!" For more details on how to get started with script writing, check out this guide: https://support.automox.com/help/newbies-guide-to-getting-started-with-automox-api

Nic-AutomoxFormer Automox Employee

posted in API & Integrations

About the Automox Labs category

API Scripts and other cool Automox tricks

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.

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?

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!

A

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

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

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?

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

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

drioskRookie

posted in API & Integrations

Automox API policy creation.

I’m creating various scripts to automate remediation and collection of service logs. I want to leverage the API to duplicate my worklets across our clients. It seems most of the info I need is in the API docs (Although if there is a more robust reference guide I would appreciate a link =) ), however, the files I need to upload to the worklet don’t seem to have a field in the JSON object. Is there a way to upload files to a worklet through the API? Thank you for any help.

Tony-AutomoxAutomox Employee

posted in API & Integrations

Get A List Of All Policies For Your Organization and Their Schedules

This API script will get a list of all of your policies in your organization and put them in an Excel spreadsheet. NOTE: Due to the way Excel auto-formats, the “schedule months” column may show in scientific notation due to the length. To fix the display of them, highlight the column, right-click on the column, click Format Column, choose Custom, then set the Type to 0. 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 on the device 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. Example days per week : For scheduling days of the week, there will be 7 digits with a trailing zero to mark the end. Th

Tony-AutomoxAutomox Employee

posted in API & Integrations

Check Compliance of Any Patch Policy, Worklet, or Required Software Policy

Original script written by @AX-Jon in May 2021, this will check compliance against any system the policy is running against. It can check for a policy, worklet, or required software policy. 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 on the device 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. $policyID - put your PolicyID for the policy, worklet, or required software policy here. The easiest way to find the policy ID is to go to the page of the policy and grab the value in the URL after the “&pid=” : [https://console.automox.com/policy-custom-editor?frompage=system-management&pid=99

LaurieL-AutomoxAutomox Employee

posted in API & Integrations

Invite Users from CSV - Bash Script

Hi all, I’m the API Tech Docs Writer here at Automox, and I wanted to introduce myself and let you know I’m here for any API-related questions you might have. To kick things off, here’s a quick Bash script I created. This script will allow you to invite a list of users and assign roles from a CSV to a given Automox organization. This is particularly useful in cases where you might have a number of users that need to be added, like when onboarding new employees. This script is org specific, so if you have multiple orgs, you will need to create a separate CSV for each org, containing the users to be added to that org and their roles. You would then need to run the script against each org, using the specific org id and api key. Copy the script, and save it as adduser_csv.sh in the directory of your choice. Use chmod u+x adduser_csv.sh to change the permissions of the file to make it executable. Create a CSV file containing 2 columns. The headers for these columns should be Email and R

Tony-AutomoxAutomox Employee

posted in API & Integrations

Move Multiple Computers Across Your Organization to a Target Group

This API script will move multiple computers - regardless of what group they’re currently in - to a group you specify. 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. $targetGID = 'GROUP_ID#_TO_MOVE_TO' - put your Group ID you want the devices moved to, which can be found by viewing the group page that lists devices in that particular group and grabbing the value after “gid=” in the URL. $toMove - Put your list of device names you want to be moved in quotes separated by a comma. You can also modify $logpath if you want to change the location where the

Nic-AutomoxFormer Automox Employee

posted in API & Integrations

Worklet Deep Dive: Create scheduled task to run at user log-on as user him/herself by Jesumyip

Following on from the first deep dive interview with @Mrichards, we have @jesumyip this time to tell us more about the creation process for his scheduled task worklet. Nic: What was the impetus for creating this worklet? Je Sum: I wanted to duplicate GPO behaviour. My goal was to eventually replace GPO in my organization with Automox. And one of the most troublesome behaviour to remove is when a group policy runs in the user context. It is difficult (not impossible, but a lot of code is required in the worklet) for the Automox agent to duplicate that behavior given that it runs in the SYSTEM context. Nic: What difficulties or obstacles did you run into? Je Sum: Trying to figure out how to work this using 100% Powershell only. I eventually realized it cannot be done - you need access to COM to complete the task. Nic: What sorts of scheduled tasks are you automating using this worklet? Je Sum: It is mostly registry changes now - for example, disabling macros in Office to avoid macro-rela

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'

Tony-AutomoxAutomox Employee

posted in API & Integrations

API Report Replicating Impacted Devices on the Software Page (By Days Exposed)

This report is similar to viewing the software page, but it only reports the number of impacted devices (devices needing the patch) ordered by days exposed. It will look something like this: image2177×879 76 KB 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. $apiKey = 'YOUR_API_KEY' $orgID = 'YOUR_ORG_ID' $filepath = "C:\Temp\software_not_installed.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=$limi

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 = '

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

jesumyipPower User

posted in API & Integrations

Clean up Automox Licenses

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 }

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

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

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 -

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.

1
2

Page 1 / 2