Additional attribute with complete URL for the Computer object and Group object.
computer_url - Complete URL to computer record in the Dashboardgroup_url - Complete URL to group in the DashboardAdditional filters including serial number, added ID, reference email and platform for the Computer object.
serial_number - Filter computers by Serial Number.
asset_id - Filter computers by Asset ID.
reference_email_computer - Filter computers by reference email address for computer(s).
reference_email_group - Filter computers by reference email address for group.
reference_email - Filter computers by reference email address, searching both computer and group reference email addresses.
platform - Filter computers by platform. Options are: linux, mac, windowsThe 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.
This update also adds access to the Visible attribute on the Plugin Result Object.
visible boolean attribute for the visible state of service pluginsThis update deprecates watchman_id in favor of client_id for the Computer object.
client_id to the Computer object.watchman_id attribute will be sent as an alias for client_id on the Computer object and removed in next API version.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.
build_installers to Find or Create Endpoint to the Group object.product_description, reference_email, and estimated_manufacture_date to Update Endpoint of the Computer object.contact_email parameter is sent as an alias on both Group and Computer objects. The alias will be removed in next API version.This update adds the ability to optionally pass a ticket_url parameter when muting a plugin result.
ticket_url parameter can be optionally passed with a timed or ticket mute_typeticket mute_typeThis update adds access to the Description and Contact Menu visibility attributes on the Group Object.
This update adds a new Find or Create Endpoint as well as some support for additional attributes on the Group object.
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).mac_installer_url to the Group object. This attribute will return the URL to the Group-Specific Mac pkg installer.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).windows_installer_url to the Group object. This attribute will return the URL to the Group-Specific Windows msi installer.This update adds access to Operating System attributes on the Computer Object.
os_version_number to the computer object. This attribute will return only the numbered version of the os_version. i.e. 10.12.1os_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.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.
Where the Universal Resource Object ID has been "id": "c_165f745e6b", it will now be "uid": "c_165f745e6b".
In v2.5, This API can now be used to update the asset_id and description of the Computer Object.
In former versions of the API the Plugin Result slug was being passed as the Plugin Result id. In this version, the slug and uid are different attributes.
uid.slug.This update adds access to Boot Volume attributes in raw bytes on the computer object.
boot_volume_capacity_in_bytes to the computer object.boot_volume_usage_in_bytes to the computer object.This update adds access to Boot Volume Usage Percent on the computer object. This is a decimal output of the percentage of volume that is used.
boot_volume_usage_percent to the computer object.This update adds access to Boot Volume attributes on the computer object. Raw values in bytes will be added in a future release.
boot_volume_capacity to the computer object.boot_volume_usage to the computer object.This update changes the Computer Name attribute on the computer object.
machine_name with computer_name. The old value will be sent until API v2.3This update adds some RAM related attributes on the computer object.
ram_installed_in_bytes to the computer object.ram_speed to the computer object.ram_upgradeable to the computer object.ram_max_apple to the computer object.ram_max_actual to the computer object.installed_ram with ram_installed. The old value will be sent until API v2.3This 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.
create and update methods for several resources have been corrected.created_at of the Group's creation date. The old value will be sent until API v2.3This 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.
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 worksMany 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.
c_165f745e6b. Our request would look something like this:https://your_subdomain.monitoringclient.com/v2.2/computers/c_165f745e6b?api_key=This_Example_API_Key{
"id": "c_165f745e6b",
"watchman_id": "20140620-S994-7TXF1R",
"agent_version": "6.3.1",
"build_number": "7D306",
"last_report": 1442026136,
"date_created": 1442025819,
"group": "g_ac21d783d9",
...
}https://your_subdomain.monitoringclient.com/v2.2/computers/c_165f745e6b&expand[]=group?api_key=This_Example_API_Key{
"id": "c_165f745e6b",
"watchman_id": "20140620-S994-7TXF1R",
"agent_version": "6.3.1",
"build_number": "7D306",
"last_report": 1442026136,
"date_created": 1442025819,
"group": {
"id": "g_ac21d783d9",
"slug": "test-group",
"name": "Test Group",
"notes": "Sample note text",
"visible_computer_count": 2,
"hidden_computer_count": 0,
"created_at": 1442025819
},
...
}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:
| Key | Type | Description |
|---|---|---|
| status_code | integer | The HTTP response code |
| code | string | The Watchman Monitoring status code |
| title | string | The title of this error |
| details | string | The details of the error |
| attribute | string | This is only sent in the case of 422 :unprocessable_entity errors and reflects the attribute which failed validation. |
date_created key to created key for uniformity with other resources.watchman_id to the computer object.slug to the Group object.display_name to the Computer Object.visibility parameter to the List Groups Endpoint.visibility to the Group Object.missing to the Computer Object.hidden to the Computer Object.platform to the Computer Object.api_key for clarity.