Automox Servers API is now Fast By Default
As of January 27, 2025, the Automox Servers
A subset of Assets, a general term denoting anything that runs the Automox Agent and is registered with the system. 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 changed?
The simplest way to interact with the servers API
A method for programmatic platform access. is this:
https://console.automox.com/api/servers?o=144237&l=75
When using this default configuration, the API implicitly includes 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 its APIs, Automox is changing this behavior. You now need to explicitly request server details, next patch time, and server events.
Automox has 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). Automox has updated the default state to return a minimal data set, with the additional detail now being optional.
- New Parameters:
- Automox has 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 ofdetailswill be{}. - If you set this parameter to
1, the completedetailsobject is included in the response.
include_server_events- This parameter allows you to specify whether to include
reboot_deferral_countandpatch_deferral_countin the response. - By default, this parameter is set to
0, which means that the value ofreboot_deferral_countandpatch_deferral_countwill be0. - If you set this parameter to
1, thereboot_deferral_countandpatch_deferral_countwill show the actual values in the response.
- This parameter allows you to specify whether to include
include_next_patch_time- This parameter allows you to specify whether to include the
next_patch_timein the response. - By default, this parameter is set to
0, which means that the value ofnext_patch_timewill benull. - If you set this parameter to
1, thenext_patch_timewill show the actual value in the response.
This is the most significant performance improvement; depending on the size of your organization
A subset of an account. An Automox customer account can be tied to multiple organizations, and users can be invited to, and access multiple organizations. An organization contains users, devices, and policies. the response time can be nearly 10 times faster. If you do not need the
devices next patch times, do not set include_next_patch_time=1and you will get data much sooner.- This parameter allows you to specify whether to include the
exclude_policy_status- This parameter allows you to specify whether to exclude
policy_statusandstatusin the response. - By default, this parameter is set to
0, which means that the values ofpolicy_statusandstatusare included in the response. - If you set this parameter to
1, the value ofpolicy_statuswill be[], and the value ofstatuswill be{}.
- This parameter allows you to specify whether to exclude
Examples
- Parity with current behavior: https://console.automox.com/api/servers?o=123456&l=75&include_details=1&include_next_patch_time=1&include_server_events=1
- (Recommended) Near parity with current behavior, excluding a time-consuming calculation of next patch time: https://console.automox.com/api/servers?o=123456=75&include_details=1&include_server_events=1
- Basic server information: https://console.automox.com/api/servers?o=123456&l=75
- Fastest known query params: https://console.automox.com/api/servers?o=123456&l=75&exclude_policy_status=1
- You can define inverse behavior with a value of 0: https://console.automox.com/api/servers?o=123456&l=500&include_details=1&include_next_patch_time=0&include_server_events=1&exclude_policy_status=0
