# Automox Product & Developer Documentation > Automox is a cloud-native IT automation platform for patch management, software deployment, configuration management, and vulnerability remediation across Windows, macOS, and Linux endpoints. This documentation covers the Automox Console, agent installation and requirements, policies, worklets, integrations, the Automox API, and release notes. The documentation is published at https://docs.automox.com/product/ and is built with MadCap Flare. Pages below link to individual topics on that site. For product support visit https://help.automox.com/hc/en-us; for the community visit https://community.automox.com. ## Getting Started - [Quick Start Guide — Patch Management in Minutes](https://docs.automox.com/product/Content/Product%20Documentation/Getting%20Started/Quick_Start_Guide___Patch_Management_in_Minutes.htm): First-run walkthrough for new Automox tenants. - [Navigating the Automox Console](https://docs.automox.com/product/Content/Product%20Documentation/Getting%20Started/Navigating%20the%20Automox%20Console.htm): Overview of the console UI and primary navigation. - [Onboarding Jumpstart Guide — Manage Your Environment](https://docs.automox.com/product/Content/Product%20Documentation/Getting%20Started/Onboarding_Jumpstart_Guide___Manage_Your_Environment.htm): Setting up organizations, users, and device groups. - [Onboarding Jumpstart Guide — Patching](https://docs.automox.com/product/Content/Product%20Documentation/Getting%20Started/Onboarding_Jumpstart_Guide___Patching.htm): Building your first patch policies. - [Onboarding Jumpstart Guide — Worklets and Required Software](https://docs.automox.com/product/Content/Product%20Documentation/Getting%20Started/Onboarding_Jumpstart_Guide___Worklets_and_Required_Software.htm): Deploying scripts and required apps via worklets. - [Security Best Practices When Setting Up Your Environment](https://docs.automox.com/product/Content/Product%20Documentation/Getting%20Started/Security_Best_Practices_When_Setting_Up_Your_Environment.htm): Hardening guidance for new tenants. - [Automox University](https://docs.automox.com/product/Content/Product%20Documentation/Getting%20Started/Automox_University.htm): Self-paced training and certification. ## Agent Requirements & Installation - [Automox Agent Requirements](https://docs.automox.com/product/Content/Product%20Documentation/Agents/Agent%20Requirements/Automox%20Agent%20Requirements.htm): CPU, memory, disk, and OS prerequisites. - [Supported Operating Systems](https://docs.automox.com/product/Content/Product%20Documentation/Agents/Agent%20Requirements/Supported_Operating_Systems.htm): Current list of supported Windows, macOS, and Linux versions. - [Agent Firewall Allowlisting Rules](https://docs.automox.com/product/Content/Product%20Documentation/Agents/Agent%20Requirements/Agent_Firewall_Allowlisting_Rules.htm): Endpoints and ports the agent must reach. - [Location of Files Required by Automox](https://docs.automox.com/product/Content/Product%20Documentation/Agents/Agent%20Requirements/Location_of_Files_Required_By_Automox.htm): Filesystem paths used by the agent on each OS. - [TLS Configuration Requirements](https://docs.automox.com/product/Content/Product%20Documentation/Agents/Agent%20Requirements/TLS_Configuration_Requirements.htm): Minimum TLS versions and certificate requirements. - [Automox Agent Installation Overview](https://docs.automox.com/product/Content/Product%20Documentation/Agents/Agent%20Installation/Automox_Agent_Installation_Overview.htm): Installation methods across platforms. - [Download Links for the Latest Automox Installers](https://docs.automox.com/product/Content/Product%20Documentation/Agents/Agent%20Installation/Download_Links_for_the_Latest_Automox_Installers.htm): Current installer URLs. - [Install and Configure Automox Agent for Apple Silicon](https://docs.automox.com/product/Content/Product%20Documentation/Agents/Agent%20Installation/Install_and_Configure_Automox_Agent_for_Apple_Silicon_Devices.htm): ARM64 macOS install steps. - [Installing the Automox Agent on Linux](https://docs.automox.com/product/Content/Product%20Documentation/Agents/Agent%20Installation/Installing_the_Automox_Agent_on_Linux.htm): Package-based installation for supported distributions. - [Removing the Automox Agent](https://docs.automox.com/product/Content/Product%20Documentation/Agents/Agent%20Installation/Removing_the_Automox_Agent.htm): Uninstall procedures per platform. ## Automox Console - [Automox Console Dashboard](https://docs.automox.com/product/Content/Product%20Documentation/Console%20Overview/Automox%20Console%20Dashboard.htm): Default landing view and key widgets. - [Automox Compliance](https://docs.automox.com/product/Content/Product%20Documentation/Console%20Overview/Automox_Compliance.htm): Compliance reporting concepts and views. - [Reporting Your Environment](https://docs.automox.com/product/Content/Product%20Documentation/Console%20Overview/Automox_and_Reporting_Your_Environment.htm): Built-in reports and exports. - [Supported Browsers for the Automox Platform](https://docs.automox.com/product/Content/Product%20Documentation/Console%20Overview/Supported_Browsers_for_the_Automox_Platform.htm): Tested browser versions. - [What the Statuses Found in the Automox Console Mean](https://docs.automox.com/product/Content/Product%20Documentation/Console%20Overview/What_the_Statuses_Found_in_the_Automox_Console_Mean.htm): Reference for device, policy, and patch status labels. ## SSO/SAML - [Automox Okta Single Sign-on (SSO) Integration](https://docs.automox.com/product/Content/Product%20Documentation/Console%20Overview/Automox_Okta_Single_Sign_on__SSO__Integration.htm): Okta SSO setup walkthrough. - [Configuring SAML for Microsoft Entra ID (Azure ID)](https://docs.automox.com/product/Content/Product%20Documentation/Console%20Overview/Configuring_SAML_for_Microsoft_Entra_ID__Azure_ID_.htm): Entra ID configuration walkthrough. - [Inviting Users When SSO Is Enabled](https://docs.automox.com/product/Content/Product%20Documentation/Console%20Overview/Inviting_Users_When_Single_Sign_on__SSO__is_Enabled.htm): User invite flow under SSO. - [Multi-Organization SAML Single Sign-On](https://docs.automox.com/product/Content/Product%20Documentation/Console%20Overview/Multi_Organization_SAML_Single_Sign_On.htm): SSO across multiple Automox orgs. ## Global Access Management - [Understanding Global Access Management](https://docs.automox.com/product/Content/Product%20Documentation/Global%20Access%20Management/Understanding_Global_Access_Management.htm): Concepts for multi-org tenants. - [Managing Organizations](https://docs.automox.com/product/Content/Product%20Documentation/Global%20Access%20Management/Managing_Organizations.htm): Creating and configuring orgs. - [Managing Users](https://docs.automox.com/product/Content/Product%20Documentation/Global%20Access%20Management/Managing_Users.htm): User lifecycle across orgs. - [Managing Global Keys](https://docs.automox.com/product/Content/Product%20Documentation/Global%20Access%20Management/Managing%20Global%20Keys.htm): Tenant-wide API key management. - [Roles and Permissions](https://docs.automox.com/product/Content/Product%20Documentation/Global%20Access%20Management/Roles_and_Permissions.htm): RBAC role catalog. - [Single Org RBAC Guidelines](https://docs.automox.com/product/Content/Product%20Documentation/Global%20Access%20Management/Single_Org_RBAC_Guidelines.htm): Guidance for single-org RBAC. - [Moving Devices From One Organization to Another](https://docs.automox.com/product/Content/Product%20Documentation/Global%20Access%20Management/Moving_Devices_From_One_Organization_to_Another.htm): Inter-org device migration. - [Global Session Settings](https://docs.automox.com/product/Content/Product%20Documentation/Global%20Access%20Management/Global_Session_Settings.htm): Session timeout and security settings. ## Devices - [Managing Devices](https://docs.automox.com/product/Content/Product%20Documentation/Device%20Management/Managing_Devices.htm): Day-to-day device operations. - [Device Details](https://docs.automox.com/product/Content/Product%20Documentation/Device%20Management/Device_Details.htm): Information shown on the device detail page. - [Device Explorer](https://docs.automox.com/product/Content/Product%20Documentation/Device%20Management/Device_Explorer.htm): Searching and grouping devices. - [Filtering and Searching on the Devices Page](https://docs.automox.com/product/Content/Product%20Documentation/Device%20Management/Filtering_and_Searching_on_the_Devices_Page.htm): Filter syntax and saved views. - [Managing Your Inventory](https://docs.automox.com/product/Content/Product%20Documentation/Device%20Management/Managing_Your_Inventory.htm): Hardware and software inventory. - [Configuring Software on a Device](https://docs.automox.com/product/Content/Product%20Documentation/Device%20Management/Configuring_Software_on_a_Device.htm): Per-device software configuration. ## Policies - [Managing Policies](https://docs.automox.com/product/Content/Product%20Documentation/Policies/Managing_Policies.htm): Policy lifecycle and operations. - [Policy Catalog](https://docs.automox.com/product/Content/Product%20Documentation/Policies/Policy%20Catalog.htm): Browsing and using prebuilt policies. - [Creating a Patch Policy](https://docs.automox.com/product/Content/Product%20Documentation/Policies/Creating_a_Patch_Policy.htm): Step-by-step patch policy creation. - [Creating a Required Software Policy](https://docs.automox.com/product/Content/Product%20Documentation/Policies/Creating_a_Required_Software_Policy.htm): Enforcing required apps with a policy. - [Creating a Worklet](https://docs.automox.com/product/Content/Product%20Documentation/Policies/Creating_a_Worklet.htm): Authoring a custom worklet policy. - [Cloning Policies](https://docs.automox.com/product/Content/Product%20Documentation/Policies/Cloning_Policies.htm): Duplicating existing policies. - [Device Targeting with Filters](https://docs.automox.com/product/Content/Product%20Documentation/Policies/Device_Targeting_with_Filters.htm): Targeting devices by filter criteria. - [Setting a Patching Schedule](https://docs.automox.com/product/Content/Product%20Documentation/Policies/Setting_a_Patching_Schedule.htm): Schedule windows and cadence. - [Using a Manual Approval Policy](https://docs.automox.com/product/Content/Product%20Documentation/Patching/Using_a_Manual_Approval_Policy.htm): Workflow for manual patch approval. - [Using the Advanced Patch Policy](https://docs.automox.com/product/Content/Product%20Documentation/Patching/Using_the_Advanced_Patch_Policy.htm): Advanced patch policy options. ## Patching & Severity - [Best Practices for Patching in Automox](https://docs.automox.com/product/Content/Product%20Documentation/Patching/What_Are_the_Recommended_Best_Practices_for_Patching_in_Automox_.htm): Recommended patching strategy. - [macOS Best Practices — Patch Notifications & CVEs](https://docs.automox.com/product/Content/Product%20Documentation/Patching/macOS_Best_Practices__Patch_Notifications___CVEs.htm): macOS-specific patching guidance. - [Understanding Automox Severity Data](https://docs.automox.com/product/Content/Product%20Documentation/Patching/Understanding_Automox_Severity_Data.htm): How severity is sourced and scored. - [How to Ensure You're Really Patching What You Think](https://docs.automox.com/product/Content/Product%20Documentation/Patching/How_to_Ensure_You_re_Really_Patching_What_You_Think.htm): Verification techniques. - [Why Patch Scoring Differs Between Automox and Other Tools](https://docs.automox.com/product/Content/Product%20Documentation/Patching/Sometimes_Patch_Scoring_Differs_Between_Automox_and_Other_Tools.htm): Cross-tool scoring differences. - [Patching When the Severity Level Is Unknown](https://docs.automox.com/product/Content/Product%20Documentation/Patching/Patching_When_the_Severity_Level_Is_Unknown.htm): Handling unscored patches. - [On-Premise Bandwidth Optimization Options](https://docs.automox.com/product/Content/Product%20Documentation/Patching/On_Premise_Bandwidth_Optimization_Options.htm): Caching and bandwidth strategies. ## Worklets & Required Software - [About Worklets](https://docs.automox.com/product/Content/Product%20Documentation/Worklets%20&%20Required%20Software/About_Worklets.htm): Worklet concept overview. - [How to Use Worklets](https://docs.automox.com/product/Content/Product%20Documentation/Worklets%20&%20Required%20Software/How_to_Use_Worklets.htm): Authoring and running worklets. - [How to Find Application Names and Versions for Required Software Policies](https://docs.automox.com/product/Content/Product%20Documentation/Worklets%20&%20Required%20Software/How_to_Find_Application_Names_and_Versions_for_Required_Software_Policies.htm): Identifying app identifiers. - [Using the Required Software Policy](https://docs.automox.com/product/Content/Product%20Documentation/Worklets%20&%20Required%20Software/Using_the_Required_Software_Policy.htm): Required software policy details. - [Enforce BitLocker Encryption Worklet](https://docs.automox.com/product/Content/Product%20Documentation/Worklets%20&%20Required%20Software/Enforce_BitLocker_Encryption_Worklet.htm): Example worklet — BitLocker enforcement. - [Enforce Windows Registry Settings Worklet](https://docs.automox.com/product/Content/Product%20Documentation/Worklets%20&%20Required%20Software/Enforce_Windows_Registry_Settings_Worklet.htm): Example worklet — registry enforcement. - [Windows Patch Rollback Worklet](https://docs.automox.com/product/Content/Product%20Documentation/Worklets%20&%20Required%20Software/Windows_Patch_Rollback_Worklet.htm): Example worklet — patch rollback. - [Worklet Policy Best Practices](https://docs.automox.com/product/Content/Product%20Documentation/Best%20Practices/Worklet_Policy_Best_Practices.htm): Authoring guidance for production worklets. ## Worklet Catalog & Script Signing - [Using the Worklet Catalog](https://docs.automox.com/product/Content/Product%20Documentation/Worklet%20Catalog/Using_the_Worklet_Catalog.htm): Browsing and importing catalog worklets. - [Run Worklet Now](https://docs.automox.com/product/Content/Product%20Documentation/Worklet%20Catalog/Run_Worklet_Now.htm): Ad-hoc worklet execution. - [Automox Script Signing](https://docs.automox.com/product/Content/Product%20Documentation/Script%20Signing/Automox_Script_Signing.htm): Verifying signed worklet scripts. - [Script Signing FAQs](https://docs.automox.com/product/Content/Product%20Documentation/Script%20Signing/Script_Signing_FAQs.htm): Common script signing questions. ## Otto AI - [About Ask Otto](https://docs.automox.com/product/Content/Product%20Documentation/Otto%20AI/About_Ask_Otto.htm): Overview of the Ask Otto AI assistant. - [Enabling and Using Ask Otto by Automox](https://docs.automox.com/product/Content/Product%20Documentation/Otto%20AI/Enabling_and_Using_Ask_Otto_by_Automox.htm): Setup and usage. - [Short Guide to Ask Otto Prompts](https://docs.automox.com/product/Content/Product%20Documentation/Otto%20AI/Short_Guide_to_Ask_Otto_Prompts.htm): Prompt patterns that work well. - [Otto AI FAQs](https://docs.automox.com/product/Content/Product%20Documentation/Otto%20AI/Otto_AI_FAQs.htm): Common Otto questions. ## Notifications & Restarts - [End User Notifications](https://docs.automox.com/product/Content/Product%20Documentation/Notifications%20&%20Restarts/End_User_Notifications.htm): End-user-facing notification concepts. - [Managing End User Notifications](https://docs.automox.com/product/Content/Product%20Documentation/Notifications%20&%20Restarts/Managing_End_User_Notifications.htm): Configuring notifications. - [Using Restart Notifications](https://docs.automox.com/product/Content/Product%20Documentation/Notifications%20&%20Restarts/Using_Restart_Notifications.htm): Restart prompt behavior. - [Understanding Restart Error Notifications](https://docs.automox.com/product/Content/Product%20Documentation/Notifications%20&%20Restarts/Understanding_Restart_Error_Notifications.htm): Restart error reference. - [Automox Tray FAQ](https://docs.automox.com/product/Content/Product%20Documentation/Notifications%20&%20Restarts/Automox%20Tray%20FAQ.htm): System tray app FAQ. - [Tray Customization Worklets](https://docs.automox.com/product/Content/Product%20Documentation/Notifications%20&%20Restarts/Tray%20Customization%20Worklets.htm): Customizing the tray via worklets. ## Vulnerability Remediation - [Automated Vulnerability Remediation FAQ](https://docs.automox.com/product/Content/Product%20Documentation/Automox%20Integrations/Automated%20Vulnerability%20Remediation%20(AVR)/Automated_Vulnerability_Remediation_FAQ.htm): AVR overview and FAQ. - [Automated Vulnerability Remediation Integration](https://docs.automox.com/product/Content/Product%20Documentation/Automox%20Integrations/Automated%20Vulnerability%20Remediation%20(AVR)/Automated_Vulnerability_Remediation_Integration.htm): Configuring AVR integrations. - [Remediation and Configuration Management](https://docs.automox.com/product/Content/Product%20Documentation/Automox%20Integrations/Automated%20Vulnerability%20Remediation%20(AVR)/Remediation_and_Configuration_Management.htm): Remediation workflows. - [About Automox Vulnerability Sync](https://docs.automox.com/product/Content/Product%20Documentation/Vulnerability%20Sync/About_Automox_Vulnerability_Sync.htm): Manual vulnerability sync overview. - [Using Automox Vulnerability Sync](https://docs.automox.com/product/Content/Product%20Documentation/Vulnerability%20Sync/Using_Automox_Vulnerability_Sync.htm): MVS workflow. - [Exporting Vulnerability Scanner Reports](https://docs.automox.com/product/Content/Product%20Documentation/Vulnerability%20Sync/Exporting_Vulnerability_Scanner_Reports.htm): Scanner export formats. ## Settings - [Settings Overview](https://docs.automox.com/product/Content/Product%20Documentation/Settings/Settings_Overview.htm): Tenant-level settings reference. - [Profile](https://docs.automox.com/product/Content/Product%20Documentation/Settings/Profile.htm): User profile settings. - [Managing Agent Configurations](https://docs.automox.com/product/Content/Product%20Documentation/Settings/Managing%20Agent%20Configurations.htm): Org-wide agent config. - [Billing](https://docs.automox.com/product/Content/Product%20Documentation/Settings/Billing.htm): Billing console reference. - [Managing Keys](https://docs.automox.com/product/Content/Product%20Documentation/Settings/Managing_Keys.htm): API key management. - [Secrets Management](https://docs.automox.com/product/Content/Product%20Documentation/Settings/Secrets_Management.htm): Storing and using secrets. - [Security](https://docs.automox.com/product/Content/Product%20Documentation/Settings/Security.htm): Org-level security settings. - [User Accounts](https://docs.automox.com/product/Content/Product%20Documentation/Settings/User_Accounts.htm): User account management. ## Developer Documentation - [Introduction & Guide to Automox](https://docs.automox.com/product/Content/Developer/Introduction%20&%20Guide%20to%20Automox.htm): Developer-oriented intro to the platform. - [Automox API Reference](https://docs.automox.com/product/Content/Developer/Automox%20API%20Reference.htm): Full REST API reference. - [Newbie's Guide to API](https://docs.automox.com/product/Content/Developer/Newbie's%20Guide%20to%20API.htm): First steps with the Automox API. - [Tutorials & Introductions](https://docs.automox.com/product/Content/Developer/Tutorials%20&%20Introductions.htm): Hands-on API tutorials. - [Using Global API Keys](https://docs.automox.com/product/Content/Developer/Using%20Global%20API%20Keys.htm): Authenticating with global keys. - [Errors](https://docs.automox.com/product/Content/Developer/Errors.htm): API error reference. - [Automox Servers API FBD](https://docs.automox.com/product/Content/Developer/Automox%20Servers%20API%20FBD.htm): Servers API functional description. - [Policy Filters & Schedule](https://docs.automox.com/product/Content/Developer/policy_filters_schedule.htm): Policy filter and schedule fields. - [Scheduled Windows](https://docs.automox.com/product/Content/Developer/Scheduled%20Windows.htm): Schedule window reference. ## Audit Trail & OCSF - [OCSF Schema Overview](https://docs.automox.com/product/Content/Developer/OCSF%20Schema%20Overview.htm): How Automox events map to OCSF. - [OCSF Class Events](https://docs.automox.com/product/Content/Developer/OCSF%20Class%20Events.htm): Event class catalog. - [OCSF Mapping for Custom Roles Events](https://docs.automox.com/product/Content/Developer/OCSF%20Mapping%20for%20Custom%20Roles%20Events.htm): Custom roles event mappings. ## Worklet Development Kit (WDK) - [WDK Overview](https://docs.automox.com/product/Content/Developer/WDK%20Overview.htm): Introduction to the Worklet Development Kit. - [Getting Started with WDK!](https://docs.automox.com/product/Content/Developer/Getting%20Started%20with%20WDK!.htm): First-run WDK walkthrough. - [WDK FAQs](https://docs.automox.com/product/Content/Developer/WDK%20FAQs.htm): Common WDK questions. - [Networking](https://docs.automox.com/product/Content/Developer/Networking.htm): Networking primitives in the WDK. - [IPv4](https://docs.automox.com/product/Content/Developer/IPv4.htm): IPv4 helpers. - [Software](https://docs.automox.com/product/Content/Developer/Software.htm): Software inventory APIs. - [Logging](https://docs.automox.com/product/Content/Developer/Logging.htm): Logging utilities. - [Environment](https://docs.automox.com/product/Content/Developer/Environment.htm): Win32 environment APIs. - [Registry](https://docs.automox.com/product/Content/Developer/Registry.htm): Win32 registry APIs. - [WinSession](https://docs.automox.com/product/Content/Developer/WinSession.htm): Win32 session APIs. - [Worklet Resources](https://docs.automox.com/product/Content/Developer/Worklet%20Resources.htm): Sample worklets and reference material. ## Release Notes - [Documentation Release Notes Landing Page](https://docs.automox.com/product/Content/Product%20Documentation/Release%20Notes/Documentation%20Release%20Notes/ReleaseNotesLP.htm): Monthly documentation release notes index. - [May 2026 Release Notes](https://docs.automox.com/product/Content/Product%20Documentation/Release%20Notes/Documentation%20Release%20Notes/May%202026%20Release%20Notes.htm): Documentation updates for May 2026. - [April 2026 Release Notes](https://docs.automox.com/product/Content/Product%20Documentation/Release%20Notes/Documentation%20Release%20Notes/April%202026%20Release%20Notes.htm): Documentation updates for April 2026. - [Agent Release Process](https://docs.automox.com/product/Content/Product%20Documentation/Release%20Notes/Agent%20Release%20Notes/Agent%20Release%20Process.htm): How Automox releases agent versions. - [Agent 2.5.68 Release Notes](https://docs.automox.com/product/Content/Product%20Documentation/Release%20Notes/Agent%20Release%20Notes/Agent%202.5.68%20Release%20Notes.htm): Latest agent release notes. - [Agent 2.5.x Release Notes](https://docs.automox.com/product/Content/Product%20Documentation/Release%20Notes/Agent%20Release%20Notes/Agent%202.5.x%20Release%20Notes.htm): Rolling 2.5.x release notes. ## FAQs & Policies - [Automox FAQs](https://docs.automox.com/product/Content/Product%20Documentation/FAQs/Automox%20FAQs.htm): Top-level product FAQs. - [Maintenance Policy](https://docs.automox.com/product/Content/Product%20Documentation/Maintenance%20Policy%20and%20Agent%20Update%20Policy/Maintenance_Policy.htm): Maintenance windows and service policy. - [Automox Agent Update Policy](https://docs.automox.com/product/Content/Product%20Documentation/Maintenance%20Policy%20and%20Agent%20Update%20Policy/Automox_Agent_Update_Policy.htm): How and when agents auto-update. - [Agent Versioning and Support](https://docs.automox.com/product/Content/Product%20Documentation/Maintenance%20Policy%20and%20Agent%20Update%20Policy/Agent_Versioning_and_Support.htm): Supported agent versions. - [Customer Data Deletion](https://docs.automox.com/product/Content/Product%20Documentation/Maintenance%20Policy%20and%20Agent%20Update%20Policy/Customer_Data_Deletion.htm): Data deletion policy. - [Billing Policy for Agents on Virtual Instances](https://docs.automox.com/product/Content/Product%20Documentation/Miscellaneous/Billing_Policy_for_Agents_on_Virtual_Instances.htm): Billing rules for VMs. ## Optional - [Automox Help Center](https://help.automox.com/hc/en-us): Customer support portal (separate from this product documentation). - [Automox Community](https://community.automox.com): Community forum. - [Automox Community Resources](https://docs.automox.com/product/Content/Developer/Automox%20Community%20Resources.htm): Community-contributed scripts and worklets. - [Troubleshooting the Automox Agent Installation on macOS](https://docs.automox.com/product/Content/Product%20Documentation/Troubleshooting/Troubleshooting_the_Automox_Agent_Installation_on_macOS.htm): macOS install troubleshooting.