Automox Servers API is now Fast By Default

As of January 27, 2025, the Automox Servers API is now Fast By Default. This change improves the performance of the Automox Servers API by optimizing the way that data is retrieved and processed.

What have we changed?

The simplest way to interact with our servers API is this: https://console.automox.com/api/servers?o=144237&l=75

When using this default configuration, we implicitly include a lot of additional information about the servers. Expressed explicitly, this would be: https://console.automox.com/api/servers?o=144237&l=75&include_details=1&include_next_patch_time=1&include_server_events=1

To speed up our APIs, Automox is changing this behavior. You will now need to explicitly request server details, next patch time, and server events.

We have made several changes to the Automox Servers API to improve performance:

  • Changes to the default settings:
    • The Automox Servers API previously returned a lot of detail about each device (server). We have updated the default state to return a minimal data set, with the additional detail now being optional.
  • New Parameters:
    • We have added new parameters to the API that allow you to choose whether to include device details, server events, and next patch time.
    • The new parameters are:
      • include_details
        • This parameter allows you to specify whether you want to include details about each device in the response.
        • By default, this parameter is set to 0 , which means that the value of details will be {} .
        • If you set this parameter to 1 , the complete details object will be included in the response.
      • include_server_events
        • This parameter allows you to specify whether to include reboot_deferral_count and patch_deferral_count in the response.
        • By default, this parameter is set to 0 , which means that the value of reboot_deferral_count and patch_deferral_count will be 0 .
        • If you set this parameter to 1 , the reboot_deferral_count and patch_deferral_count will show the actual values in the response.
      • include_next_patch_time
        • This parameter allows you to specify whether to include the next_patch_time in the response.
        • By default, this parameter is set to 0 , which means that the value of next_patch_time will be null .
        • If you set this parameter to 1 , the next_patch_time will show the actual value in the response.
          success

          This is the most significant performance improvement; depending on the size of your organization the response time can be nearly 10 times faster. If you do not need the devices next patch times, do not set includenextpatchtime=1 _and you will get data much sooner.

      • exclude_policy_status
        • This parameter allows you to specify whether to exclude policy_status and status in the response.
        • By default, this parameter is set to 0 , which means that the values of policy_status and status will be included in the response.
        • If you set this parameter to 1 , the value of policy_status will be [] , and the value of status will be {} .

Examples