Skip to main content
Tools Reference

ConnectWise Automate Tools

Written By Christopher Scaminaci

Last updated 7 days ago

ConnectWise Automate Tools

cwa_ · 207 tools · Free 123 · Pro 84 ConnectWise Automate (LabTech) REST API; raw JSON passthrough.

All connector tools · ConnectWise Automate setup guide

ConnectWise Automate tool groups

System & Configuration

ToolPlanAccessSummary
cwa_get_patch_informationFreeRead-onlyRetrieve global patch information for the Automate server.
cwa_get_server_infoFreeRead-onlyRetrieve server information including version, hostname, and configuration details.
cwa_get_server_timeFreeRead-onlyRetrieve the current date and time from the database server.
cwa_list_commandsFreeRead-onlyList commands with optional filtering and pagination.
cwa_list_feature_flagsFreeRead-onlyList feature flags with optional filtering and pagination.
cwa_list_licensed_productsFreeRead-onlyList licensed products with optional filtering and pagination.
cwa_list_linksFreeRead-onlyList configured links with optional filtering and pagination.
cwa_list_pluginsFreeRead-onlyList installed plugins with optional filtering and pagination.
cwa_list_reboot_policiesFreeRead-onlyList reboot policies with optional filtering and pagination.
cwa_list_virus_scanner_defsFreeRead-onlyList virus scanner definitions with optional filtering and pagination.
cwa_set_feature_flagsProDestructiveSet feature flags to enable or disable features on the Automate server.
cwa_update_virus_scanner_defsProDestructiveTrigger an update of virus scanner definitions.

[ConnectWise Automate] Retrieve global patch information for the Automate server. Returns patch configuration, approval policies, and patch inventory statistics.

[ConnectWise Automate] Retrieve server information including version, hostname, and configuration details. Returns the Automate server's current status and build info.

[ConnectWise Automate] Retrieve the current date and time from the database server. Useful for verifying time synchronization and timezone configuration.

[ConnectWise Automate] List commands with optional filtering and pagination. Returns command names, types, and execution details. Use this to discover available commands for automation.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List feature flags with optional filtering and pagination. Returns feature flag names and their enabled/disabled status. Use this to check which features are active on the Automate server.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List licensed products with optional filtering and pagination. Returns product names, license keys, and expiration details.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List installed plugins with optional filtering and pagination. Returns plugin names, versions, and status.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List reboot policies with optional filtering and pagination. Returns policy names, schedules, and configuration details.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List virus scanner definitions with optional filtering and pagination. Returns antivirus definition names, versions, and update timestamps.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Set feature flags to enable or disable features on the Automate server. The JSON body should contain an array of feature flag objects with their desired states.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON array of feature flag objects. Example: [{"Name":"FeatureA","Enabled":true}].

[ConnectWise Automate] Trigger an update of virus scanner definitions. The JSON body specifies which definitions to update and any configuration overrides.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the virus scanner definition update. Example: {"DefinitionId":1,"ForceUpdate":true}.

Users & Access

ToolPlanAccessSummary
cwa_change_user_passwordProDestructiveChange the password for a specific user.
cwa_create_auth_linkProDestructiveCreate an authentication link for a specific user.
cwa_create_userProWriteCreate a new user in ConnectWise Automate.
cwa_delete_userProDestructiveDelete a user from ConnectWise Automate.
cwa_get_client_permissionsFreeRead-onlyRetrieve permissions for a specific client.
cwa_get_userFreeRead-onlyRetrieve a specific user by ID.
cwa_get_user_accessFreeRead-onlyRetrieve access rights for a specific user.
cwa_get_user_favoritesFreeRead-onlyRetrieve favorites for a specific user.
cwa_get_user_foldersFreeRead-onlyRetrieve the folder structure visible to users.
cwa_get_user_settingsFreeRead-onlyRetrieve settings for a specific user.
cwa_list_external_credentialsFreeRead-onlyList external system credentials for a specific client.
cwa_list_user_permissionsFreeRead-onlyList user permissions with optional filtering and pagination.
cwa_list_usersFreeRead-onlyList users with optional filtering and pagination.
cwa_update_userProWriteUpdate an existing user.

[ConnectWise Automate] Change the password for a specific user. Requires a valid user ID -- use cwa_list_users to find IDs.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with the new password. Example: {"NewPassword":"SecureP@ss123"}.
userIdstringyesThe ConnectWise Automate user ID.

[ConnectWise Automate] Create a new user in ConnectWise Automate. The JSON body should contain user details including name, email, and user class assignment.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the user to create. Example: {"Name":"jdoe","Email":"jdoe@contoso.com","UserClassId":1}.

[ConnectWise Automate] Delete a user from ConnectWise Automate. This is a destructive operation that removes the user account. Requires a valid user ID -- use cwa_list_users to find IDs.

ParamTypeRequiredDefaultDescription
userIdstringyesThe ConnectWise Automate user ID to delete.

[ConnectWise Automate] Retrieve permissions for a specific client. Returns the effective permissions for all user classes on this client. Requires a valid client ID -- use cwa_list_clients to find IDs.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe ConnectWise Automate client ID.

[ConnectWise Automate] Retrieve a specific user by ID. Returns full user details including name, email, user class, and permissions. Requires a valid user ID -- use cwa_list_users to find IDs.

ParamTypeRequiredDefaultDescription
userIdstringyesThe ConnectWise Automate user ID.

[ConnectWise Automate] Retrieve access rights for a specific user. Returns the user's effective permissions across clients and locations. Requires a valid user ID -- use cwa_list_users to find IDs.

ParamTypeRequiredDefaultDescription
userIdstringyesThe ConnectWise Automate user ID.

[ConnectWise Automate] Retrieve favorites for a specific user. Returns bookmarked items and saved views. Requires a valid user ID -- use cwa_list_users to find IDs.

ParamTypeRequiredDefaultDescription
userIdstringyesThe ConnectWise Automate user ID.

[ConnectWise Automate] Retrieve the folder structure visible to users. Returns folder hierarchy including scripts, searches, and groups.

[ConnectWise Automate] Retrieve settings for a specific user. Returns user preferences and configuration. Requires a valid user ID -- use cwa_list_users to find IDs.

ParamTypeRequiredDefaultDescription
userIdstringyesThe ConnectWise Automate user ID.

[ConnectWise Automate] List external system credentials for a specific client. Returns credential entries for integrations like remote access, antivirus, and backup tools. Requires a valid client ID -- use cwa_list_clients to find IDs.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe ConnectWise Automate client ID.

[ConnectWise Automate] List user permissions with optional filtering and pagination. Returns permission assignments across all users including role, scope, and access level.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List users with optional filtering and pagination. Returns user summaries including ID, name, email, and user class. Use this to discover user IDs for access and permission queries.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Example: "Email like '%@contoso.com%'". Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Update an existing user. Only include fields that need to change in the JSON body. Requires a valid user ID -- use cwa_list_users to find IDs.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update. Example: {"Email":"newemail@contoso.com"}.
userIdstringyesThe ConnectWise Automate user ID to update.

User Classes

ToolPlanAccessSummary
cwa_create_user_classProWriteCreate a new user class in ConnectWise Automate.
cwa_delete_user_classProDestructiveDelete a user class by ID.
cwa_get_user_classFreeRead-onlyRetrieve a specific user class by ID.
cwa_get_user_class_extensionsFreeRead-onlyRetrieve web extensions configured for a specific user class.
cwa_list_user_classesFreeRead-onlyList user classes with optional filtering and pagination.
cwa_update_user_classProWriteUpdate an existing user class.

[ConnectWise Automate] Create a new user class in ConnectWise Automate. The JSON body should contain the class name and permission definitions.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the user class to create. Example: {"Name":"Tier 1 Technicians","Permissions":{"Computers":true}}.

[ConnectWise Automate] Delete a user class by ID. This is a destructive operation that removes the user class and may affect users assigned to it. Requires a valid user class ID.

ParamTypeRequiredDefaultDescription
userClassIdstringyesThe ConnectWise Automate user class ID to delete.

[ConnectWise Automate] Retrieve a specific user class by ID. Returns full user class details including permission assignments and web extensions. Requires a valid user class ID -- use cwa_list_user_classes to find IDs.

ParamTypeRequiredDefaultDescription
userClassIdstringyesThe ConnectWise Automate user class ID.

[ConnectWise Automate] Retrieve web extensions configured for a specific user class. Returns extension URLs, labels, and display settings. Requires a valid user class ID -- use cwa_list_user_classes to find IDs.

ParamTypeRequiredDefaultDescription
userClassIdstringyesThe ConnectWise Automate user class ID.

[ConnectWise Automate] List user classes with optional filtering and pagination. Returns user class definitions including name, permissions, and member count. Use this to discover user class IDs for permission management.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Update an existing user class. Only include fields that need to change in the JSON body. Requires a valid user class ID -- use cwa_list_user_classes to find IDs.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update. Example: {"Name":"Senior Technicians"}.
userClassIdstringyesThe ConnectWise Automate user class ID to update.

Auditing

ToolPlanAccessSummary
cwa_create_user_auditProWriteCreate a new user audit record.
cwa_list_user_auditsFreeRead-onlyList user audit records with optional filtering and pagination.

[ConnectWise Automate] Create a new user audit record. The JSON body should contain the audit details including the action performed and any relevant context.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the audit record to create. Example: {"UserName":"admin","Action":"ConfigChange","Details":"Updated patch policy"}.

[ConnectWise Automate] List user audit records with optional filtering and pagination. Returns audit entries including user, action, timestamp, and details. Use condition to filter by date range, user, or action type.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Example: "UserName = 'admin'". Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

Clients

ToolPlanAccessSummary
cwa_create_clientProWriteCreate a new client (company/organization).
cwa_delete_clientProDestructiveDelete a client by ID.
cwa_get_clientFreeRead-onlyRetrieve full details for a single client by ID.
cwa_get_client_extra_fieldsFreeRead-onlyRetrieve extra data fields (custom fields) for a specific client.
cwa_list_client_documentsFreeRead-onlyList documents attached to a specific client.
cwa_list_clientsFreeRead-onlyList clients (companies/organizations) with optional filtering and pagination.
cwa_replace_clientProDestructiveFully replace an existing client using PUT.
cwa_update_clientProWritePartially update an existing client using PATCH.

[ConnectWise Automate] Create a new client (company/organization). Returns the created client with its assigned ID. The JSON body should include at minimum 'Name'. Example: {"Name":"Contoso Ltd","City":"Seattle","State":"WA"}.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the client to create. Must include 'Name'. Example: {"Name":"Contoso Ltd","City":"Seattle","State":"WA"}.

[ConnectWise Automate] Delete a client by ID. This is a destructive operation that removes the client and may cascade to associated locations, computers, and contacts. Requires a valid client ID.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe ConnectWise Automate client ID to delete.

[ConnectWise Automate] Retrieve full details for a single client by ID. Returns client info including name, address, city, state, and custom fields. Requires a valid client ID -- use cwa_list_clients to find IDs.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe ConnectWise Automate client ID.

[ConnectWise Automate] Retrieve extra data fields (custom fields) for a specific client. Returns field names and values configured on the client. Requires a valid client ID -- use cwa_list_clients to find IDs.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe ConnectWise Automate client ID.

[ConnectWise Automate] List documents attached to a specific client. Returns document metadata including name, type, and upload date. Requires a valid client ID -- use cwa_list_clients to find IDs.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe ConnectWise Automate client ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List clients (companies/organizations) with optional filtering and pagination. Returns client summaries including ID, name, and city. Use this to discover client IDs for scoping locations, computers, contacts, and other client-level resources.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Example: "Name like '%Contoso%'". Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Fully replace an existing client using PUT. The JSON body must contain all required fields; any omitted optional fields will be reset to defaults. Requires a valid client ID.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe ConnectWise Automate client ID to replace.
fieldsJsonstringyesComplete JSON object for the client. All required fields must be present. Example: {"Name":"Contoso Ltd","City":"Portland","State":"OR"}.

[ConnectWise Automate] Partially update an existing client using PATCH. Only the fields provided in the JSON body will be modified; all other fields remain unchanged. Requires a valid client ID.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe ConnectWise Automate client ID to update.
fieldsJsonstringyesJSON object with fields to update. Example: {"City":"Portland","State":"OR"}.

Client Sub-Resources

ToolPlanAccessSummary
cwa_create_client_licenseProDestructiveAssign a new license to a specific client.
cwa_create_client_product_keyProDestructiveStore a new product key for a specific client.
cwa_delete_client_permissionsProDestructiveDelete permissions for a specific client and user class combination.
cwa_list_client_licensesFreeRead-onlyList licenses assigned to a specific client.
cwa_list_client_permissionsFreeRead-onlyList permissions for a specific client and user class combination.
cwa_list_client_product_keysFreeRead-onlyList product keys stored for a specific client.
cwa_set_client_permissionsProDestructiveCreate or set permissions for a specific client and user class combination using POST.
cwa_update_client_permissionsProDestructiveFully replace permissions for a specific client and user class combination using PUT.

[ConnectWise Automate] Assign a new license to a specific client. The JSON body should include license product and key details. Requires a valid client ID.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe ConnectWise Automate client ID.
fieldsJsonstringyesJSON object for the license to create. Example: {"ProductName":"Office 365","LicenseKey":"XXXXX-XXXXX","ExpirationDate":"2027-01-01"}.

[ConnectWise Automate] Store a new product key for a specific client. The JSON body should include the product name and key value. Requires a valid client ID.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe ConnectWise Automate client ID.
fieldsJsonstringyesJSON object for the product key to create. Example: {"ProductName":"Windows Server 2025","ProductKey":"XXXXX-XXXXX-XXXXX","Notes":"DC license"}.

[ConnectWise Automate] Delete permissions for a specific client and user class combination. Removes all permission entries for the given user class on this client. Requires both a client ID and a user class ID.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe ConnectWise Automate client ID.
userClassIdstringyesThe user class ID to delete permissions for.

[ConnectWise Automate] List licenses assigned to a specific client. Returns license details including product name, key, and expiration. Requires a valid client ID -- use cwa_list_clients to find IDs.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe ConnectWise Automate client ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List permissions for a specific client and user class combination. Returns permission entries defining what actions the user class can perform on the client. Requires both a client ID and a user class ID.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe ConnectWise Automate client ID.
userClassIdstringyesThe user class ID to retrieve permissions for.

[ConnectWise Automate] List product keys stored for a specific client. Returns product key entries including product name, key value, and notes. Requires a valid client ID -- use cwa_list_clients to find IDs.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe ConnectWise Automate client ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Create or set permissions for a specific client and user class combination using POST. Defines what actions the user class can perform on this client. Requires both a client ID and a user class ID.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe ConnectWise Automate client ID.
fieldsJsonstringyesJSON object defining the permissions. Example: {"Computers":true,"Remoting":true,"Scripts":false}.
userClassIdstringyesThe user class ID to set permissions for.

[ConnectWise Automate] Fully replace permissions for a specific client and user class combination using PUT. All permission fields must be provided; omitted fields will be reset. Requires both a client ID and a user class ID.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe ConnectWise Automate client ID.
fieldsJsonstringyesComplete JSON object for the permissions. All fields must be present. Example: {"Computers":true,"Remoting":true,"Scripts":true}.
userClassIdstringyesThe user class ID to update permissions for.

Locations

ToolPlanAccessSummary
cwa_create_locationProWriteCreate a new location (site) under a client.
cwa_delete_locationProDestructiveDelete a location by ID.
cwa_list_locationsFreeRead-onlyList locations (sites) across all clients with optional filtering and pagination.
cwa_replace_locationProDestructiveFully replace an existing location using PUT.
cwa_update_locationProWritePartially update an existing location using PATCH.

[ConnectWise Automate] Create a new location (site) under a client. The JSON body should include at minimum 'Name' and 'ClientId'. Returns the created location with its assigned ID.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the location to create. Must include 'Name' and 'ClientId'. Example: {"Name":"Main Office","ClientId":5,"Address":"123 Main St","City":"Seattle","State":"WA"}.

[ConnectWise Automate] Delete a location by ID. This is a destructive operation that removes the location and may cascade to associated computers and network devices. Requires a valid location ID.

ParamTypeRequiredDefaultDescription
locationIdstringyesThe ConnectWise Automate location ID to delete.

[ConnectWise Automate] List locations (sites) across all clients with optional filtering and pagination. Returns location summaries including ID, name, client ID, address, and router info. Use this to discover location IDs for scoping computers, network devices, and other location-level resources.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Example: "ClientId = 5" or "Name like '%Main%'". Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Fully replace an existing location using PUT. The JSON body must contain all required fields; any omitted optional fields will be reset to defaults. Requires a valid location ID.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesComplete JSON object for the location. All required fields must be present. Example: {"Name":"Main Office","ClientId":5,"Address":"456 Oak Ave","City":"Portland","State":"OR"}.
locationIdstringyesThe ConnectWise Automate location ID to replace.

[ConnectWise Automate] Partially update an existing location using PATCH. Only the fields provided in the JSON body will be modified; all other fields remain unchanged. Requires a valid location ID -- use cwa_list_locations to find IDs.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update. Example: {"Address":"456 Oak Ave","City":"Portland"}.
locationIdstringyesThe ConnectWise Automate location ID to update.

Location Extra Fields

ToolPlanAccessSummary
cwa_delete_location_extra_fieldProDestructiveDelete an extra data field (custom field) value from a location.
cwa_update_location_extra_fieldProWritePartially update an extra data field (custom field) on a location using PATCH.

[ConnectWise Automate] Delete an extra data field (custom field) value from a location. Removes the stored value for the specified extra field. Requires both a location ID and the extra field ID.

ParamTypeRequiredDefaultDescription
idstringyesThe extra field ID to delete.
locationIdstringyesThe ConnectWise Automate location ID.

[ConnectWise Automate] Partially update an extra data field (custom field) on a location using PATCH. Only the fields provided in the JSON body will be modified. Requires both a location ID and the extra field ID -- use cwa_list_locations and inspect the location's ExtraFields to find IDs.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update. Example: {"Value":"Updated notes"}.
idstringyesThe extra field ID to update.
locationIdstringyesThe ConnectWise Automate location ID.

Computers

ToolPlanAccessSummary
cwa_create_computer_menuProWriteCreate a custom right-click menu entry for computers.
cwa_get_computer_alertsFreeRead-onlyRetrieve alerts for a specific computer.
cwa_get_computer_command_historyFreeRead-onlyRetrieve command execution history for a specific computer.
cwa_list_computersFreeRead-onlyList computers with optional filtering and pagination.

[ConnectWise Automate] Create a custom right-click menu entry for computers. The JSON body defines the menu label, command, and target scope. Use this to add automation shortcuts to the computer context menu.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the computer menu to create. Example: {"Name":"Run Cleanup","Command":"cleanup.bat","MenuType":1}.

[ConnectWise Automate] Retrieve alerts for a specific computer. Returns alert details including severity, message, and timestamp. Requires a valid computer ID -- use cwa_list_computers to find IDs.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve command execution history for a specific computer. Returns past commands including type, status, and output. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List computers with optional filtering and pagination. Returns computer summaries including ID, name, OS, domain, and status. Use this to discover computer IDs for hardware, software, patching, and maintenance queries.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Example: "OS like '%Windows%'". Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

Alert Suspensions

ToolPlanAccessSummary
cwa_create_monitor_alert_suspensionProDestructiveCreate a new monitor alert suspension for a specific computer.
cwa_get_maintenance_alert_suspensionsFreeRead-onlyRetrieve maintenance-window alert suspensions for a specific computer.
cwa_get_monitor_alert_suspensionsFreeRead-onlyRetrieve monitor-based alert suspensions for a specific computer.
cwa_get_template_alert_suspensionsFreeRead-onlyRetrieve template-based alert suspensions for a specific computer.

[ConnectWise Automate] Create a new monitor alert suspension for a specific computer. Suppresses alerts from the specified monitor for the given duration. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
fieldsJsonstringyesJSON object for the monitor alert suspension. Example: {"MonitorId":123,"SuspendUntil":"2026-04-10T00:00:00Z"}.

[ConnectWise Automate] Retrieve maintenance-window alert suspensions for a specific computer. Returns suspension details including start/end times and scope. Requires a valid computer ID -- use cwa_list_computers to find IDs.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve monitor-based alert suspensions for a specific computer. Returns suspended monitors including monitor ID, suspension reason, and duration. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve template-based alert suspensions for a specific computer. Returns suspension rules applied via alert templates. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

Computer Hardware

ToolPlanAccessSummary
cwa_get_computer_biosFreeRead-onlyRetrieve BIOS information for a specific computer.
cwa_get_computer_chassisFreeRead-onlyRetrieve chassis information for a specific computer.
cwa_get_computer_devicesFreeRead-onlyRetrieve hardware devices attached to a specific computer.
cwa_get_computer_driversFreeRead-onlyRetrieve installed drivers for a specific computer.
cwa_get_computer_drivesFreeRead-onlyRetrieve disk drives for a specific computer.
cwa_get_computer_memory_slotsFreeRead-onlyRetrieve memory slot information for a specific computer.
cwa_get_computer_processorsFreeRead-onlyRetrieve processor (CPU) information for a specific computer.
cwa_get_computer_system_slotsFreeRead-onlyRetrieve system expansion slot information for a specific computer.
cwa_get_computer_upsFreeRead-onlyRetrieve UPS (uninterruptible power supply) information for a specific computer.
cwa_get_computer_video_cardsFreeRead-onlyRetrieve video card (GPU) information for a specific computer.
cwa_get_drive_smart_dataFreeRead-onlyRetrieve S.M.A.R.T.

[ConnectWise Automate] Retrieve BIOS information for a specific computer. Returns BIOS vendor, version, date, and serial number. Requires a valid computer ID -- use cwa_list_computers to find IDs.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve chassis information for a specific computer. Returns chassis type, manufacturer, serial number, and asset tag. Requires a valid computer ID -- use cwa_list_computers to find IDs.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve hardware devices attached to a specific computer. Returns device details including type, name, manufacturer, and status. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve installed drivers for a specific computer. Returns driver details including name, version, provider, and date. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve disk drives for a specific computer. Returns drive details including letter, label, file system, total size, and free space. Use cwa_get_drive_smart_data for health diagnostics on a specific drive. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve memory slot information for a specific computer. Returns slot details including capacity, speed, type (DDR4/DDR5), and bank label. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve processor (CPU) information for a specific computer. Returns processor details including name, manufacturer, clock speed, core count, and architecture. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve system expansion slot information for a specific computer. Returns slot details including type (PCI, PCIe, AGP), designation, and current usage status. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve UPS (uninterruptible power supply) information for a specific computer. Returns UPS details including model, battery status, load percentage, and estimated runtime. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve video card (GPU) information for a specific computer. Returns GPU details including name, manufacturer, memory size, and driver version. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve S.M.A.R.T. diagnostic data for a specific drive on a computer. Returns health attributes, thresholds, and failure predictions. Requires a valid computer ID and drive ID -- use cwa_get_computer_drives to find drive IDs.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
driveIdstringyesThe drive ID within this computer.

Computer Software & Services

ToolPlanAccessSummary
cwa_classify_serviceProDestructiveClassify a Windows service for monitoring or management purposes.
cwa_get_computer_printersFreeRead-onlyRetrieve printers installed on a specific computer.
cwa_get_computer_servicesFreeRead-onlyRetrieve Windows services running on a specific computer.
cwa_get_computer_softwareFreeRead-onlyRetrieve installed software for a specific computer.
cwa_uninstall_softwareProDestructiveTrigger uninstallation of a specific software package on a computer.

[ConnectWise Automate] Classify a Windows service for monitoring or management purposes. Sets the service category, importance, and monitoring rules. Requires a valid service ID -- use cwa_get_computer_services to find service IDs.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the classification. Example: {"Classification":"Critical","MonitorEnabled":true}.
serviceIdstringyesThe service ID to classify.

[ConnectWise Automate] Retrieve printers installed on a specific computer. Returns printer details including name, port, driver, and default status. Requires a valid computer ID -- use cwa_list_computers to find IDs.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve Windows services running on a specific computer. Returns service details including name, display name, status (Running/Stopped), and startup type. Use cwa_classify_service to categorize a service. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve installed software for a specific computer. Returns software details including name, version, publisher, and install date. Use cwa_list_global_software for fleet-wide software inventory. Requires a valid computer ID -- use cwa_list_computers to find IDs.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Trigger uninstallation of a specific software package on a computer. Queues the uninstall command for the Automate agent to execute. Requires valid computer and software IDs -- use cwa_get_computer_software to find software IDs.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
softwareIdstringyesThe software ID to uninstall from this computer.

Computer OS & Networking

ToolPlanAccessSummary
cwa_get_computer_monitorsFreeRead-onlyRetrieve display monitors connected to a specific computer.
cwa_get_computer_osFreeRead-onlyRetrieve operating system details for a specific computer.
cwa_get_computer_sensorsFreeRead-onlyRetrieve hardware sensor readings for a specific computer.

[ConnectWise Automate] Retrieve display monitors connected to a specific computer. Returns monitor details including manufacturer, model, resolution, and serial number. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve operating system details for a specific computer. Returns OS name, version, build number, architecture, service pack, and install date. Requires a valid computer ID -- use cwa_list_computers to find IDs.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.

[ConnectWise Automate] Retrieve hardware sensor readings for a specific computer. Returns sensor data including temperature, fan speed, and voltage readings. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

Computer Patching

ToolPlanAccessSummary
cwa_get_computer_effective_patch_policyFreeRead-onlyRetrieve the effective (merged) patching policy for a specific computer.
cwa_get_computer_microsoft_updatesFreeRead-onlyRetrieve Microsoft update status for a specific computer.
cwa_get_computer_patch_jobsFreeRead-onlyRetrieve patch job history for a specific computer.
cwa_get_computer_patching_policiesFreeRead-onlyRetrieve patching policies assigned to a specific computer.
cwa_get_computer_patching_statsFreeRead-onlyRetrieve patching statistics for a specific computer.

[ConnectWise Automate] Retrieve the effective (merged) patching policy for a specific computer. This is the result of combining all applicable policies from computer, group, client, and global levels. Returns the final approval rules, categories, and schedule that apply. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.

[ConnectWise Automate] Retrieve Microsoft update status for a specific computer. Returns available and installed updates including KB number, title, severity, and install status. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve patch job history for a specific computer. Returns past and scheduled patch jobs including status, start/end times, and patches applied. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve patching policies assigned to a specific computer. Returns policy details including approval rules, patch categories, and schedule windows. Use cwa_get_computer_effective_patch_policy to see the merged effective policy. Requires a valid computer ID -- use cwa_list_computers to find IDs.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve patching statistics for a specific computer. Returns a summary of total patches, installed count, missing count, and compliance percentage. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.

Third-Party Patches

ToolPlanAccessSummary
cwa_get_computer_third_party_patchesFreeRead-onlyRetrieve third-party patch status for a specific computer.

[ConnectWise Automate] Retrieve third-party patch status for a specific computer. Returns non-Microsoft patches including application name, vendor, installed version, available version, and compliance status. Use cwa_get_computer_microsoft_updates for Microsoft patches. Requires a valid computer ID -- use cwa_list_computers to find IDs.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

Computer Scripts

ToolPlanAccessSummary
cwa_execute_commandProDestructiveExecute a command on a specific computer via the Automate agent.
cwa_get_computer_running_scriptsFreeRead-onlyRetrieve currently running scripts on a specific computer.
cwa_get_computer_script_historyFreeRead-onlyRetrieve script execution history for a specific computer.
cwa_schedule_computer_scriptProDestructiveSchedule a script to run on a specific computer.

[ConnectWise Automate] Execute a command on a specific computer via the Automate agent. Queues the command for execution and returns the command ID for tracking. Use cwa_get_computer_command_history to check results. Requires a valid computer ID -- use cwa_list_computers to find IDs.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
fieldsJsonstringyesJSON object for the command to execute. Example: {"Command":"ipconfig /all","CommandType":1,"TimeOut":30}.

[ConnectWise Automate] Retrieve currently running scripts on a specific computer. Returns active script executions including script name, start time, and status. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve script execution history for a specific computer. Returns past script runs including script name, start/end times, exit code, and output. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Schedule a script to run on a specific computer. The script will execute at the specified time or immediately if no schedule is provided. Use cwa_get_computer_script_history to check execution results. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
fieldsJsonstringyesJSON object for the scheduled script. Example: {"ScriptId":123,"Parameters":"param1=value1","RunDate":"2026-04-10T09:00:00Z"}.

Computer Maintenance

ToolPlanAccessSummary
cwa_get_computer_maintenance_modesFreeRead-onlyRetrieve maintenance mode windows for a specific computer.
cwa_get_computer_scheduled_scriptsFreeRead-onlyRetrieve scheduled scripts for a specific computer.
cwa_schedule_computer_taskProDestructiveSchedule a maintenance task on a specific computer.

[ConnectWise Automate] Retrieve maintenance mode windows for a specific computer. Returns active and scheduled maintenance periods including start/end times, type, and creator. Use cwa_list_global_maintenance_modes for fleet-wide maintenance overview. Requires a valid computer ID -- use cwa_list_computers to find IDs.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve scheduled scripts for a specific computer. Returns upcoming and recurring script schedules including script name, next run time, and recurrence pattern. Use cwa_schedule_computer_script to add a new scheduled script. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Schedule a maintenance task on a specific computer. Creates a one-time or recurring scheduled task such as disk cleanup, defrag, or custom scripts. Requires a valid computer ID.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe ConnectWise Automate computer ID.
fieldsJsonstringyesJSON object for the scheduled task. Example: {"TaskName":"Disk Cleanup","TaskType":1,"RunDate":"2026-04-10T02:00:00Z","Recurrence":"Weekly"}.

Fleet-Wide Queries

ToolPlanAccessSummary
cwa_list_global_chassisFreeRead-onlyList chassis information across all managed computers.
cwa_list_global_drivesFreeRead-onlyList disk drives across all managed computers.
cwa_list_global_maintenance_modesFreeRead-onlyList maintenance mode windows across all managed computers.
cwa_list_global_memory_slotsFreeRead-onlyList memory slot information across all managed computers.
cwa_list_global_softwareFreeRead-onlyList software installations across all managed computers.

[ConnectWise Automate] List chassis information across all managed computers. Returns chassis records including type, manufacturer, serial number, and associated computer. Use this for fleet-wide hardware audits. Use cwa_get_computer_chassis for a single computer.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List disk drives across all managed computers. Returns drive records including letter, label, total size, free space, and associated computer. Use this for fleet-wide disk space audits. Use cwa_get_computer_drives for a single computer.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List maintenance mode windows across all managed computers. Returns active and scheduled maintenance periods including computer, start/end times, and type. Use this for fleet-wide maintenance visibility. Use cwa_get_computer_maintenance_modes for a single computer.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List memory slot information across all managed computers. Returns memory slot records including capacity, speed, type, and associated computer. Use this for fleet-wide RAM audits or upgrade planning. Use cwa_get_computer_memory_slots for a single computer.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List software installations across all managed computers. Returns software records including name, version, publisher, and associated computer. Use this for fleet-wide software audits or license compliance. Use cwa_get_computer_software for a single computer.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

Alerts

ToolPlanAccessSummary
cwa_delete_retired_assetProDestructivePermanently delete a retired asset record.
cwa_list_alertsFreeRead-onlyList alerts across all managed computers.
cwa_list_retired_assetsFreeRead-onlyList retired (decommissioned) assets.

[ConnectWise Automate] Permanently delete a retired asset record. This action cannot be undone. Requires a valid retired asset ID -- use cwa_list_retired_assets to find IDs.

ParamTypeRequiredDefaultDescription
assetIdstringyesThe retired asset ID to delete.

[ConnectWise Automate] List alerts across all managed computers. Returns alert details including severity, message, computer, and timestamp. Use cwa_get_computer_alerts for alerts on a specific computer. Use condition filtering to narrow by severity or date range.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List retired (decommissioned) assets. Returns retired asset records including original computer name, retirement date, and reason. Use cwa_delete_retired_asset to permanently remove a retired asset record.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

Contacts

ToolPlanAccessSummary
cwa_create_contactProWriteCreate a new contact using the v2 endpoint.
cwa_delete_contactProDestructiveDelete a contact by ID using the v2 endpoint.
cwa_get_contactFreeRead-onlyRetrieve full details for a single contact by ID using the v2 endpoint.
cwa_list_contactsFreeRead-onlyList contacts using the preferred v2 endpoint with optional filtering and pagination.
cwa_list_contacts_v1FreeRead-onlyList contacts using the legacy v1 endpoint (read-only).
cwa_list_system_contactsFreeRead-onlyList system-level contacts with optional filtering and pagination.
cwa_update_contactProDestructiveFully replace an existing contact using PUT on the v2 endpoint.

[ConnectWise Automate] Create a new contact using the v2 endpoint. The JSON body should include at minimum 'FirstName' and 'LastName'. Returns the created contact with its assigned ID.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the contact to create. Must include 'FirstName' and 'LastName'. Example: {"FirstName":"Jane","LastName":"Doe","Email":"jane@contoso.com","ClientId":5,"LocationId":1}.

[ConnectWise Automate] Delete a contact by ID using the v2 endpoint. This is a destructive operation that permanently removes the contact record. Requires a valid contact ID.

ParamTypeRequiredDefaultDescription
contactIdstringyesThe ConnectWise Automate contact ID to delete.

[ConnectWise Automate] Retrieve full details for a single contact by ID using the v2 endpoint. Returns all contact fields including name, email, phone numbers, title, and client/location associations. Requires a valid contact ID -- use cwa_list_contacts to find IDs.

ParamTypeRequiredDefaultDescription
contactIdstringyesThe ConnectWise Automate contact ID.

[ConnectWise Automate] List contacts using the preferred v2 endpoint with optional filtering and pagination. Returns contact details including ID, first name, last name, email, phone, and client/location associations. This is the recommended endpoint for contact queries with full CRUD support.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Example: "LastName like '%Smith%'". Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List contacts using the legacy v1 endpoint (read-only). Returns contact summaries including ID, name, email, phone, and client association. For full CRUD operations prefer the v2 contacts endpoint (cwa_list_contacts, cwa_create_contact, etc.).

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Example: "Email like '%@contoso.com%'". Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List system-level contacts with optional filtering and pagination. System contacts are internal contacts not tied to a specific client. Returns contact summaries including ID, name, email, and role.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Fully replace an existing contact using PUT on the v2 endpoint. The JSON body must contain all required fields; any omitted optional fields will be reset to defaults. Requires a valid contact ID -- use cwa_list_contacts to find IDs.

ParamTypeRequiredDefaultDescription
contactIdstringyesThe ConnectWise Automate contact ID to update.
fieldsJsonstringyesComplete JSON object for the contact. All required fields must be present. Example: {"FirstName":"Jane","LastName":"Doe","Email":"jane.doe@contoso.com","Phone":"555-0199"}.

Tickets

ToolPlanAccessSummary
cwa_get_ticketFreeRead-onlyRetrieve full details for a single ticket by ID.
cwa_list_ticketsFreeRead-onlyList tickets with optional filtering and pagination.

[ConnectWise Automate] Retrieve full details for a single ticket by ID. Returns all ticket fields including subject, description, status, priority, category, client, computer, and assigned technician. Requires a valid ticket ID -- use cwa_list_tickets to find IDs.

ParamTypeRequiredDefaultDescription
ticketIdstringyesThe ConnectWise Automate ticket ID.

[ConnectWise Automate] List tickets with optional filtering and pagination. Returns ticket summaries including ID, subject, status, priority, client, and assigned technician. Use this to find ticket IDs and review open or recent tickets across clients.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Example: "Status = 'New'" or "ClientId = 5". Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

Scripts

ToolPlanAccessSummary
cwa_copy_scriptProWriteCreate a copy of an existing script by ID.
cwa_create_scriptProWriteCreate a new script using the v2 API.
cwa_create_script_v1ProWriteCreate a new script using the v1 API.
cwa_delete_scriptProDestructiveDelete a script by ID using the v2 API.
cwa_delete_script_scheduleProDestructiveDelete a script schedule by ID.
cwa_get_scriptFreeRead-onlyRetrieve a single script by ID using the v2 API.
cwa_list_running_scriptsFreeRead-onlyList currently running scripts with optional filtering and pagination.
cwa_list_script_schedulesFreeRead-onlyList scheduled script executions with optional filtering and pagination.
cwa_list_scriptsFreeRead-onlyList scripts with optional filtering and pagination.
cwa_update_scriptProDestructiveUpdate an existing script by ID using the v2 API.
cwa_update_script_scheduleProDestructiveUpdate a script schedule using JSON Patch.

[ConnectWise Automate] Create a copy of an existing script by ID. Returns the newly created script copy. Requires a valid script ID -- use cwa_list_scripts to find IDs.

ParamTypeRequiredDefaultDescription
scriptIdstringyesThe ConnectWise Automate script ID to copy.

[ConnectWise Automate] Create a new script using the v2 API. The JSON body defines the script name, folder, parameters, and content. Returns the created script object.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the script to create. Example: {"Name":"Patch Scan","FolderId":1,"ScriptType":1}.

[ConnectWise Automate] Create a new script using the v1 API. The JSON body defines the script name, folder, type, and content. Returns the created script object.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the script to create. Example: {"Name":"Disk Cleanup","FolderId":1,"ScriptType":1}.

[ConnectWise Automate] Delete a script by ID using the v2 API. Permanently removes the script. Requires a valid script ID -- use cwa_list_scripts to find IDs.

ParamTypeRequiredDefaultDescription
scriptIdstringyesThe ConnectWise Automate script ID.

[ConnectWise Automate] Delete a script schedule by ID. Permanently removes the scheduled execution. Requires a valid schedule ID -- use cwa_list_script_schedules to find IDs.

ParamTypeRequiredDefaultDescription
scheduledIdstringyesThe ConnectWise Automate scheduled script ID.

[ConnectWise Automate] Retrieve a single script by ID using the v2 API. Returns full script details including name, folder, parameters, and content. Requires a valid script ID -- use cwa_list_scripts to find IDs.

ParamTypeRequiredDefaultDescription
scriptIdstringyesThe ConnectWise Automate script ID.

[ConnectWise Automate] List currently running scripts with optional filtering and pagination. Returns active script executions including computer, script name, status, and start time.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List scheduled script executions with optional filtering and pagination. Returns schedule details including script name, target, frequency, and next run time.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List scripts with optional filtering and pagination. Returns script summaries including ID, name, folder, and type. Use this to discover script IDs for execution and scheduling.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Example: "Name like '%Cleanup%'". Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Update an existing script by ID using the v2 API. The JSON body contains the full updated script object. Requires a valid script ID -- use cwa_list_scripts to find IDs.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with the full updated script. Example: {"Name":"Disk Cleanup v2","FolderId":1,"ScriptType":1}.
scriptIdstringyesThe ConnectWise Automate script ID.

[ConnectWise Automate] Update a script schedule using JSON Patch. Modifies specific fields on the schedule without replacing the entire object. Requires a valid schedule ID -- use cwa_list_script_schedules to find IDs.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON Patch array. Example: [{"op":"replace","path":"/Enabled","value":false}].
scheduledIdstringyesThe ConnectWise Automate scheduled script ID.

Script Folders

ToolPlanAccessSummary
cwa_create_script_folderProWriteCreate a new script folder.
cwa_create_v2_script_folderProWriteCreate a new script folder using the v2 API.
cwa_delete_script_folderProDestructiveDelete a script folder by ID.
cwa_get_script_folderFreeRead-onlyRetrieve a single script folder by ID.
cwa_get_script_folder_hierarchyFreeRead-onlyRetrieve the full script folder hierarchy as a tree structure.
cwa_list_script_foldersFreeRead-onlyList script folders with optional filtering and pagination.
cwa_update_script_folderProWriteUpdate a script folder using JSON Patch.

[ConnectWise Automate] Create a new script folder. The JSON body defines the folder name and optional parent folder. Returns the created folder object.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the script folder to create. Example: {"Name":"Maintenance Scripts","ParentId":1}.

[ConnectWise Automate] Create a new script folder using the v2 API. The JSON body defines the folder name and optional parent folder. Returns the created folder object.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the script folder to create. Example: {"Name":"Automation Scripts","ParentId":1}.

[ConnectWise Automate] Delete a script folder by ID. Permanently removes the folder and its contents. Requires a valid folder ID -- use cwa_list_script_folders to find IDs.

ParamTypeRequiredDefaultDescription
entityIdstringyesThe ConnectWise Automate script folder entity ID.

[ConnectWise Automate] Retrieve a single script folder by ID. Returns full folder details including name, parent, and permissions. Requires a valid folder ID -- use cwa_list_script_folders to find IDs.

ParamTypeRequiredDefaultDescription
entityIdstringyesThe ConnectWise Automate script folder entity ID.

[ConnectWise Automate] Retrieve the full script folder hierarchy as a tree structure. Returns all folders with their parent-child relationships. Useful for understanding folder organization before creating or moving scripts.

[ConnectWise Automate] List script folders with optional filtering and pagination. Returns folder summaries including ID, name, and parent folder. Use this to discover folder IDs for organizing scripts.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Example: "Name like '%Maintenance%'". Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Update a script folder using JSON Patch. Modifies specific fields on the folder without replacing the entire object. Requires a valid folder ID -- use cwa_list_script_folders to find IDs.

ParamTypeRequiredDefaultDescription
entityIdstringyesThe ConnectWise Automate script folder entity ID.
fieldsJsonstringyesJSON Patch array. Example: [{"op":"replace","path":"/Name","value":"Renamed Folder"}].

Groups

ToolPlanAccessSummary
cwa_add_group_computersProDestructiveAdd computers to a group.
cwa_add_group_network_devicesProDestructiveAdd network devices to a group.
cwa_create_groupProWriteCreate a new group.
cwa_delete_groupProDestructiveDelete a group by ID.
cwa_get_groupFreeRead-onlyRetrieve a single group by ID.
cwa_list_group_computersFreeRead-onlyList computers belonging to a specific group with optional filtering and pagination.
cwa_list_group_network_devicesFreeRead-onlyList network devices belonging to a specific group with optional filtering and pagination.
cwa_list_groupsFreeRead-onlyList groups with optional filtering and pagination.
cwa_remove_group_computersProDestructiveRemove computers from a group.
cwa_remove_group_network_devicesProDestructiveRemove network devices from a group.
cwa_update_groupProWriteUpdate a group using JSON Patch.

[ConnectWise Automate] Add computers to a group. The JSON body contains the list of computer IDs to add. Requires a valid group ID -- use cwa_list_groups to find IDs.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with computer IDs to add. Example: {"ComputerIds":[1,2,3]}.
groupIdstringyesThe ConnectWise Automate group ID.

[ConnectWise Automate] Add network devices to a group. The JSON body contains the list of network device IDs to add. Requires a valid group ID -- use cwa_list_groups to find IDs.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with network device IDs to add. Example: {"NetworkDeviceIds":[1,2,3]}.
groupIdstringyesThe ConnectWise Automate group ID.

[ConnectWise Automate] Create a new group. The JSON body defines the group name, parent, and configuration. Returns the created group object.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the group to create. Example: {"Name":"Windows Servers","ParentId":1}.

[ConnectWise Automate] Delete a group by ID. Permanently removes the group. Computers in the group are not deleted. Requires a valid group ID -- use cwa_list_groups to find IDs.

ParamTypeRequiredDefaultDescription
groupIdstringyesThe ConnectWise Automate group ID.

[ConnectWise Automate] Retrieve a single group by ID. Returns full group details including name, parent, template properties, and auto-join rules. Requires a valid group ID -- use cwa_list_groups to find IDs.

ParamTypeRequiredDefaultDescription
groupIdstringyesThe ConnectWise Automate group ID.

[ConnectWise Automate] List computers belonging to a specific group with optional filtering and pagination. Returns computer summaries within the group. Requires a valid group ID -- use cwa_list_groups to find IDs.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
groupIdstringyesThe ConnectWise Automate group ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List network devices belonging to a specific group with optional filtering and pagination. Returns network device summaries within the group. Requires a valid group ID -- use cwa_list_groups to find IDs.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
groupIdstringyesThe ConnectWise Automate group ID.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List groups with optional filtering and pagination. Returns group summaries including ID, name, parent group, and member count. Use this to discover group IDs for computer and network device management.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Example: "Name like '%Servers%'". Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Remove computers from a group. Removes the association but does not delete the computers. Requires a valid group ID -- use cwa_list_groups to find IDs.

ParamTypeRequiredDefaultDescription
groupIdstringyesThe ConnectWise Automate group ID.

[ConnectWise Automate] Remove network devices from a group. Removes the association but does not delete the devices. Requires a valid group ID -- use cwa_list_groups to find IDs.

ParamTypeRequiredDefaultDescription
groupIdstringyesThe ConnectWise Automate group ID.

[ConnectWise Automate] Update a group using JSON Patch. Modifies specific fields on the group without replacing the entire object. Requires a valid group ID -- use cwa_list_groups to find IDs.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON Patch array. Example: [{"op":"replace","path":"/Name","value":"Renamed Group"}].
groupIdstringyesThe ConnectWise Automate group ID.

Group Policies

ToolPlanAccessSummary
cwa_delete_group_av_policiesProDestructiveDelete antivirus template policies from a group.
cwa_delete_group_template_propertiesProDestructiveDelete template properties from a group.
cwa_get_group_av_policiesFreeRead-onlyRetrieve antivirus template policies assigned to a group.
cwa_get_group_av_policy_dataFreeRead-onlyRetrieve detailed data for a specific AV template policy assigned to a group.
cwa_get_group_template_propertiesFreeRead-onlyRetrieve template properties assigned to a group.
cwa_set_group_av_policiesProDestructiveSet antivirus template policies for a group.
cwa_set_group_av_policy_dataProDestructiveSet the detailed data for a specific AV template policy on a group.
cwa_set_group_template_propertiesProDestructiveSet template properties for a group.

[ConnectWise Automate] Delete antivirus template policies from a group. Removes all AV policy assignments from the group. Requires a valid group ID -- use cwa_list_groups to find IDs.

ParamTypeRequiredDefaultDescription
groupIdstringyesThe ConnectWise Automate group ID.

[ConnectWise Automate] Delete template properties from a group. Removes all template property overrides, reverting to inherited values. Requires a valid group ID -- use cwa_list_groups to find IDs.

ParamTypeRequiredDefaultDescription
groupIdstringyesThe ConnectWise Automate group ID.

[ConnectWise Automate] Retrieve antivirus template policies assigned to a group. Returns AV policy details including template name, settings, and scope. Requires a valid group ID -- use cwa_list_groups to find IDs.

ParamTypeRequiredDefaultDescription
groupIdstringyesThe ConnectWise Automate group ID.

[ConnectWise Automate] Retrieve detailed data for a specific AV template policy assigned to a group. Returns the policy configuration including scan schedules, exclusions, and update settings. Requires valid group and AV policy IDs.

ParamTypeRequiredDefaultDescription
avPolicyIdstringyesThe ConnectWise Automate AV template policy ID.
groupIdstringyesThe ConnectWise Automate group ID.

[ConnectWise Automate] Retrieve template properties assigned to a group. Returns template property details including inherited and overridden settings. Requires a valid group ID -- use cwa_list_groups to find IDs.

ParamTypeRequiredDefaultDescription
groupIdstringyesThe ConnectWise Automate group ID.

[ConnectWise Automate] Set antivirus template policies for a group. The JSON body defines the AV policy assignments. Replaces any existing AV policies on the group. Requires a valid group ID -- use cwa_list_groups to find IDs.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with AV template policy assignments. Example: {"AVTemplatePolicyId":1,"Enabled":true}.
groupIdstringyesThe ConnectWise Automate group ID.

[ConnectWise Automate] Set the detailed data for a specific AV template policy on a group. The JSON body defines the full policy configuration. Replaces existing policy data. Requires valid group and AV policy IDs.

ParamTypeRequiredDefaultDescription
avPolicyIdstringyesThe ConnectWise Automate AV template policy ID.
fieldsJsonstringyesJSON object with the full AV policy data. Example: {"ScanSchedule":"Daily","ExcludedPaths":[]}.
groupIdstringyesThe ConnectWise Automate group ID.

[ConnectWise Automate] Set template properties for a group. The JSON body defines the template property values. Replaces existing template properties on the group. Requires a valid group ID -- use cwa_list_groups to find IDs.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with template property values. Example: {"Properties":[{"Name":"Patch Policy","Value":"Enabled"}]}.
groupIdstringyesThe ConnectWise Automate group ID.

Monitors

ToolPlanAccessSummary
cwa_get_collected_dataFreeRead-onlyGet collected monitoring data.
cwa_get_data_collection_settingsFreeRead-onlyRetrieve data collection settings for the Automate server.
cwa_get_monitor_statisticsFreeRead-onlyRetrieve aggregated monitor statistics.
cwa_list_internal_monitor_resultsFreeRead-onlyList internal monitor results with optional filtering and pagination.
cwa_list_monitor_historyFreeRead-onlyList monitor history with optional filtering and pagination.
cwa_list_sensor_checksFreeRead-onlyList sensor checks with optional filtering and pagination.

[ConnectWise Automate] Get collected monitoring data. Use condition to filter by date range or device. Returns data points collected by monitors including timestamps, values, and associated devices.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Example: "ComputerId = 123". Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Retrieve data collection settings for the Automate server. Returns configuration for how monitoring data is collected, retained, and purged.

[ConnectWise Automate] Retrieve aggregated monitor statistics. Returns summary counts of monitors by status, type, and alert state across the Automate environment.

[ConnectWise Automate] List internal monitor results with optional filtering and pagination. Returns monitor check results including status, last check time, and alert state.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List monitor history with optional filtering and pagination. Returns historical monitor check results including timestamps, status changes, and alert triggers.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Example: "MonitorId = 42". Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List sensor checks with optional filtering and pagination. Returns sensor check definitions including type, interval, and threshold configuration.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

Patching

ToolPlanAccessSummary
cwa_deploy_all_approved_patchesProDestructiveDeploy all approved patches to targeted computers.
cwa_deploy_all_security_patchesProDestructiveDeploy all security-classified patches to targeted computers.
cwa_list_approval_policiesFreeRead-onlyList patch approval policies with optional filtering and pagination.
cwa_list_group_patching_policiesFreeRead-onlyList group patching policies with optional filtering and pagination.
cwa_list_microsoft_update_policiesFreeRead-onlyList Microsoft update policies with optional filtering and pagination.
cwa_list_patch_historyFreeRead-onlyList patch installation history with optional filtering and pagination.
cwa_list_third_party_update_policiesFreeRead-onlyList third-party update policies with optional filtering and pagination.
cwa_reattempt_failed_patchesProDestructiveReattempt installation of previously failed patches.
cwa_set_patch_pilot_stageProDestructiveMove patches to the pilot deployment stage.
cwa_set_patch_production_stageProDestructiveMove patches to the production deployment stage.
cwa_set_patch_test_stageProDestructiveMove patches to the test deployment stage.

[ConnectWise Automate] Deploy all approved patches to targeted computers. The JSON body specifies the target scope and deployment options. Initiates patch installation for all patches in the approved state.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with deployment parameters. Example: {"GroupId":1,"RebootIfNeeded":true}.

[ConnectWise Automate] Deploy all security-classified patches to targeted computers. The JSON body specifies the target scope and deployment options. Initiates patch installation for security updates only.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with deployment parameters. Example: {"GroupId":1,"RebootIfNeeded":true}.

[ConnectWise Automate] List patch approval policies with optional filtering and pagination. Returns policy summaries including ID, name, approval type, and scope. Use this to discover approval policy configurations.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List group patching policies with optional filtering and pagination. Returns policy summaries including group assignments, patch windows, and reboot settings.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List Microsoft update policies with optional filtering and pagination. Returns policy details including update classifications, products, and approval rules.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List patch installation history with optional filtering and pagination. Returns patch records including KB article, install date, status, and target computer.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Example: "Status = 'Failed'". Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List third-party update policies with optional filtering and pagination. Returns policy details including vendor, product, and approval settings.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Reattempt installation of previously failed patches. The JSON body specifies the target scope and retry options. Re-queues failed patch installations for another attempt.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with retry parameters. Example: {"GroupId":1,"RebootIfNeeded":true}.

[ConnectWise Automate] Move patches to the pilot deployment stage. The JSON body specifies which patches or groups to transition. Pilot stage allows testing patches on a limited set of computers before broader rollout.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with pilot stage parameters. Example: {"PatchIds":[1,2,3],"GroupId":1}.

[ConnectWise Automate] Move patches to the production deployment stage. The JSON body specifies which patches or groups to transition. Production stage deploys patches to all targeted computers.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with production stage parameters. Example: {"PatchIds":[1,2,3],"GroupId":1}.

[ConnectWise Automate] Move patches to the test deployment stage. The JSON body specifies which patches or groups to transition. Test stage allows validating patches in a controlled environment before pilot or production rollout.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with test stage parameters. Example: {"PatchIds":[1,2,3],"GroupId":1}.

Network Devices

ToolPlanAccessSummary
cwa_create_network_deviceProWriteCreate a new network device record.
cwa_get_network_deviceFreeRead-onlyRetrieve a specific network device by ID.
cwa_list_network_devicesFreeRead-onlyList network devices with optional filtering and pagination.
cwa_list_routersFreeRead-onlyList routers with optional filtering and pagination.
cwa_update_network_deviceProWriteUpdate an existing network device.

[ConnectWise Automate] Create a new network device record. The JSON body should contain device details including name, IP address, and location.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the network device to create. Example: {"Name":"Core Switch","IpAddress":"10.0.0.1","LocationId":1}.

[ConnectWise Automate] Retrieve a specific network device by ID. Returns full device details including IP, MAC, SNMP configuration, and discovery info. Requires a valid device ID -- use cwa_list_network_devices to find IDs.

ParamTypeRequiredDefaultDescription
deviceIdstringyesThe ConnectWise Automate network device ID.

[ConnectWise Automate] List network devices with optional filtering and pagination. Returns device summaries including ID, name, IP address, MAC address, and device type. Use this to discover network device IDs.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Example: "DeviceType = 'Router'". Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] List routers with optional filtering and pagination. Returns router details including IP address, location, and discovery status.

ParamTypeRequiredDefaultDescription
conditionstringnonullCondition filter expression. Omit for no filtering.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Update an existing network device. Only include fields that need to change in the JSON body. Requires a valid device ID -- use cwa_list_network_devices to find IDs.

ParamTypeRequiredDefaultDescription
deviceIdstringyesThe ConnectWise Automate network device ID to update.
fieldsJsonstringyesJSON object with fields to update. Example: {"Name":"Core Switch v2","IpAddress":"10.0.0.2"}.

Batch Operations

ToolPlanAccessSummary
cwa_batch_execute_scriptProDestructiveExecute a script across multiple computers simultaneously.
cwa_batch_run_device_detectionProDestructiveRun network device detection across multiple probes simultaneously.
cwa_batch_schedule_scriptProDestructiveSchedule a script to run across multiple computers at a specified time.
cwa_batch_send_to_searchProDestructiveSend batch results to a saved search for further processing.

[ConnectWise Automate] Execute a script across multiple computers simultaneously. Provide computer IDs and script ID in the JSON body.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with script execution details including target computer IDs and script ID.
ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with probe command details for device detection.
ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with scheduling details including target computer IDs, script ID, and schedule time.
ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with search target details.

Probes

ToolPlanAccessSummary
cwa_create_probe_configProWriteCreate a new probe configuration for a location.
cwa_delete_probe_configProDestructiveDelete a probe configuration for a location.
cwa_delete_probe_push_credentialsProDestructiveDelete agent push credentials for a probe.
cwa_enable_probeProDestructiveEnable probe functionality on a computer.
cwa_get_probe_configFreeRead-onlyGet probe configuration for a location.
cwa_get_probe_push_credentialsFreeRead-onlyGet agent push credentials for a probe by its probe configuration ID.
cwa_get_probe_snmp_configFreeRead-onlyGet SNMP configuration for a probe by its probe configuration ID.
cwa_list_probe_eventsFreeRead-onlyList network probe discovery events with optional filtering and pagination.
cwa_set_probe_push_credentialsProDestructiveSet agent push credentials for a probe.
cwa_update_probe_configProWriteUpdate a probe configuration for a location.
cwa_update_probe_snmp_configProDestructiveUpdate SNMP configuration for a probe.
cwa_upgrade_probeProDestructiveUpgrade the probe agent at a location to the latest version.

[ConnectWise Automate] Create a new probe configuration for a location. Use cwa_list_locations to find location IDs.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with probe configuration fields.
locationIdstringyesThe location ID to create the probe configuration under.
ParamTypeRequiredDefaultDescription
locationIdstringyesThe location ID that owns the probe configuration.
ParamTypeRequiredDefaultDescription
configIdstringyesThe probe configuration ID.

[ConnectWise Automate] Enable probe functionality on a computer. The computer must be an existing managed agent. Use cwa_list_computers to find computer IDs.

ParamTypeRequiredDefaultDescription
computerIdstringyesThe computer ID to enable as a probe.
fieldsJsonstringno""JSON object with probe enable options (can be empty ).

[ConnectWise Automate] Get probe configuration for a location. Probe configs are scoped to locations — use cwa_list_locations to find location IDs.

ParamTypeRequiredDefaultDescription
conditionstringnonullFilter condition string.
locationIdstringyesThe location ID to get probe configuration for.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).
ParamTypeRequiredDefaultDescription
configIdstringyesThe probe configuration ID.
ParamTypeRequiredDefaultDescription
configIdstringyesThe probe configuration ID.
ParamTypeRequiredDefaultDescription
conditionstringnonullFilter condition string.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

[ConnectWise Automate] Set agent push credentials for a probe. Replaces the current credentials entirely.

ParamTypeRequiredDefaultDescription
configIdstringyesThe probe configuration ID.
fieldsJsonstringyesJSON object with agent push credential fields.

[ConnectWise Automate] Update a probe configuration for a location. Supports JSON Patch format.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object or JSON Patch array with update fields.
locationIdstringyesThe location ID that owns the probe configuration.

[ConnectWise Automate] Update SNMP configuration for a probe. Use cwa_get_probe_snmp_config to see current values.

ParamTypeRequiredDefaultDescription
configIdstringyesThe probe configuration ID.
fieldsJsonstringyesJSON object or JSON Patch array with SNMP configuration updates.
ParamTypeRequiredDefaultDescription
fieldsJsonstringno""JSON object with upgrade options (can be empty ).
locationIdstringyesThe location ID whose probe should be upgraded.

Probe Lookups

ToolPlanAccessSummary
cwa_list_event_levelsFreeRead-onlyList probe event level definitions.
cwa_list_network_port_optionsFreeRead-onlyList available network port options for probe status scans.
cwa_list_scan_frequenciesFreeRead-onlyList available scan frequency options for probe configurations.
cwa_list_snmp_encryption_methodsFreeRead-onlyList available SNMP encryption methods for probe network discovery.
cwa_list_snmp_hash_methodsFreeRead-onlyList available SNMP hash methods for probe authentication.

[ConnectWise Automate] List probe event level definitions. Returns the available severity/type classifications for probe events.

Searches

ToolPlanAccessSummary
cwa_create_searchProWriteCreate a saved search.
cwa_create_search_folderProWriteCreate a search folder.
cwa_list_search_foldersFreeRead-onlyList search folder structure with optional filtering and pagination.
cwa_list_searchesFreeRead-onlyList saved searches with optional filtering and pagination.
ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with search definition fields.
ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with search folder fields.
ParamTypeRequiredDefaultDescription
conditionstringnonullFilter condition string.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).
ParamTypeRequiredDefaultDescription
conditionstringnonullFilter condition string.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

Remote Agents

ToolPlanAccessSummary
cwa_create_remote_agent_scheduleProDestructiveCreate a remote agent schedule.
cwa_create_remote_agent_templateProDestructiveCreate a remote agent template.
cwa_list_remote_agent_schedulesFreeRead-onlyList remote agent schedules with optional filtering and pagination.
cwa_list_remote_agent_templatesFreeRead-onlyList remote agent templates with optional filtering and pagination.
ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with remote agent schedule fields.
ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with remote agent template fields.
ParamTypeRequiredDefaultDescription
conditionstringnonullFilter condition string.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).
ParamTypeRequiredDefaultDescription
conditionstringnonullFilter condition string.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).

Data Views & Misc

ToolPlanAccessSummary
cwa_get_user_profileFreeRead-onlyGet the current user's profile configuration.
cwa_list_data_viewsFreeRead-onlyList available data view definitions with optional filtering and pagination.
cwa_list_drive_statisticsFreeRead-onlyGet drive statistics with daily/weekly/monthly/yearly granularity.
cwa_list_event_logsFreeRead-onlyList system event log entries with optional filtering and pagination.
cwa_list_maintenance_windowsFreeRead-onlyList maintenance window definitions with optional filtering and pagination.
ParamTypeRequiredDefaultDescription
conditionstringnonullFilter condition string.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).
ParamTypeRequiredDefaultDescription
conditionstringnonullFilter condition string.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).
ParamTypeRequiredDefaultDescription
conditionstringnonullFilter condition string.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).
ParamTypeRequiredDefaultDescription
conditionstringnonullFilter condition string.
pageintegerno1Page number (default 1).
pageSizeintegerno200Results per page (default 200, max 1000).