Agent Version Consolidation v2.5 Expansion - Date Released: 22 May 2018
The Linux, Mac, and Windows versions are moving to a single version string. The concept of Build Number will be represented within the last of the four-segment version. To retain backwards compatibility in the API, the version will be printed in the build string. The separate build element will be removed in our next major release.
Deprecation Build is becoming an alias of Version, and will be removed in a future release.
Computer Object Update v2.5 Expansion - Date Released: 20 May 2018
This update also adds access to the Visible attribute on the Plugin Result Object.
Newvisible boolean attribute for the visible state of service plugins
Computer Object Update v2.5 Expansion - Date Released: 6 Mar 2018
This update deprecates watchman_id in favor of client_id for the Computer object.
Deprecationwatchman_id attribute will be sent as an alias for client_id on the Computer object and removed in next API version.
Reference Email, Beacon Controls, User Management v2.5 Expansion - Date Released: 27 Nov 2017
This update surfaces more controls for Groups and Computer Records. The ability to enable or disable Beacon Reporting is granted on a per-computer basis. A new user endpoint is added, allowing the programmatic addition or removal of users in a Company.
New Added mac_installer_ready to the Group object. This attribute will return a boolean value based on whether its Group-Specific mac installer has been published. (Usually within 20 seconds).
New Added mac_installer_url to the Group object. This attribute will return the URL to the Group-Specific Mac pkg installer.
New Added windows_installer_ready to the Group object. This attribute will return a boolean value based on whether its Group-Specific windows installer has been published. (Usually within 60 seconds).
New Added windows_installer_url to the Group object. This attribute will return the URL to the Group-Specific Windows msi installer.
Computer Object Update v2.5 Expansion - Date Released: 23 Nov 2016
This update adds access to Operating System attributes on the Computer Object.
New Added os_version_number to the computer object. This attribute will return only the numbered version of the os_version. i.e. 10.12.1
New Added os_version_number_max to the computer object. This attribute will return the latest, compatible Operating System Number the Computer can support; 0.0.0 will be returned when the computer can support the lastest released Operating System.
V2.5 Major Update Date Released: 20 Nov 2016
This update includes key changes to the universal resource ID's, Computer Object, Plugin Result Object and the removal of support for all previously deprecated elements.
Universal Resource Object ID's will now be referenced as UID
Where the Universal Resource Object ID has been "id": "c_165f745e6b", it will now be "uid": "c_165f745e6b".
This update adds some RAM related attributes on the computer object.
New Added ram_installed_in_bytes to the computer object.
New Added ram_speed to the computer object.
New Added ram_upgradeable to the computer object.
New Added ram_max_apple to the computer object.
New Added ram_max_actual to the computer object.
change Replaces installed_ram with ram_installed. The old value will be sent until API v2.3
Notes Update v2.2 Expansion - Date Released: 25 Feb 2016
This update coincides with the release of the new Notes feature in the Watchman UI. Previously, notes on Groups and computers were limited to a single, editable field. Now, notes have been moved out to their own resource which gives you greater flexibility on how Notes are seen and used. The old notes have been moved to a new field called `description`.
With this API update, Notes can now be managed through API access as well.
Fix CURL examples for the create and update methods for several resources have been corrected.
Fix Added a missing created_at of the Group's creation date. The old value will be sent until API v2.3
change Replaces Display Name with Custom Name. The old value will be sent until API v2.3
V2.2 Major Release Date Released: 29 Sep 2015
This update is the start of some enhancements to the Watchman Monitoring API to prepare for future expansion. Key changes include universal resource ID's, expandable resources and better JSON error responses.
Universal Resource Object ID's
This is going to be the largest change as you move form v2.1 to v2.2.
As we move towards expanding our API we've added uniform resource IDs. As of API v2.2 each resource returned in our API will have a unique ID with a similar structure. For example the a computer's ID might look something like c_165f745e6b and a Group's ID might be g_ac21d783d9.
These changes mean that you will no longer lookup computers by their Watchman ID, nor Groups by their slug. Instead always use this new ID structure.
In v2.1, when a resource had a nested resource we expended it by default. We found that this was causing a fair amount of load for users who didn't "need" all of that info. As of v2.2 we will not auto expand any related resource but rather we'll just return its ID. This change resulted in almost a 2 second response time increase in cases where you don't need the expanded resources.
How it works
Many resource objects contain the ID of another object in their response properties. Those objects can now be expanded inline by including an array of one or more keys in the expand request parameter.
This parameter is available on all API requests, and applies to the response of that request only. You can nest expand requests with the dot property. For example, requesting computer.plugin_results on an Expiration will expand the computer property into a full computer object, and will then expand the plugin_results property on that computer into a full customer object.
Let's use a computer record as an example. Say we wanted to get the computer with the ID of c_165f745e6b. Our request would look something like this:
We've modified the error response to be more than the string description provided in v2.1. The new JSON errors array will provide you with more detail than before about the error you've encountered. Whenever the API returns an error you'll receive a JSON array of one or more errors. These errors consist of the following keys:
The HTTP response code
The Watchman Monitoring status code
The title of this error
The details of the error
This is only sent in the case of 422 :unprocessable_entity errors and reflects the attribute which failed validation.
Fix Fixed an issue where the Plugin Result mute values sent didn't match the documentation.