ConnectWise Automate Tools
cwa_ · 207 tools · Free 123 · Pro 84
ConnectWise Automate (LabTech) REST API; raw JSON passthrough.
System & Configuration
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_get_patch_information |
Free | Read-only | [ConnectWise Automate] Retrieve global patch information for the Automate server. Returns patch configuration, approval policies, and patch inventory statistics. |
cwa_get_server_info |
Free | Read-only | [ConnectWise Automate] Retrieve server information including version, hostname, and configuration details. Returns the Automate server's current status and build info. |
cwa_get_server_time |
Free | Read-only | [ConnectWise Automate] Retrieve the current date and time from the database server. Useful for verifying time synchronization and timezone configuration. |
cwa_list_commands |
Free | Read-only | [ConnectWise Automate] List commands with optional filtering and pagination. Returns command names, types, and execution details. Use this to discover available commands for automation. |
cwa_list_feature_flags |
Free | Read-only | [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. |
cwa_list_licensed_products |
Free | Read-only | [ConnectWise Automate] List licensed products with optional filtering and pagination. Returns product names, license keys, and expiration details. |
cwa_list_links |
Free | Read-only | [ConnectWise Automate] List configured links with optional filtering and pagination. Returns link names, URLs, and associated metadata. |
cwa_list_plugins |
Free | Read-only | [ConnectWise Automate] List installed plugins with optional filtering and pagination. Returns plugin names, versions, and status. |
cwa_list_reboot_policies |
Free | Read-only | [ConnectWise Automate] List reboot policies with optional filtering and pagination. Returns policy names, schedules, and configuration details. |
cwa_list_virus_scanner_defs |
Free | Read-only | [ConnectWise Automate] List virus scanner definitions with optional filtering and pagination. Returns antivirus definition names, versions, and update timestamps. |
cwa_set_feature_flags |
Pro | Write | [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. |
cwa_update_virus_scanner_defs |
Pro | Write | [ConnectWise Automate] Trigger an update of virus scanner definitions. The JSON body specifies which definitions to update and any configuration overrides. |
cwa_list_commands parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_feature_flags parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_licensed_products parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_links parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_plugins parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_reboot_policies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_virus_scanner_defs parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_set_feature_flags parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON array of feature flag objects. Example: [{"Name":"FeatureA","Enabled":true}]. |
cwa_update_virus_scanner_defs parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the virus scanner definition update. Example: {"DefinitionId":1,"ForceUpdate":true}. |
Users & Access
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_change_user_password |
Pro | Write | [ConnectWise Automate] Change the password for a specific user. Requires a valid user ID -- use cwa_list_users to find IDs. |
cwa_create_auth_link |
Pro | Write | [ConnectWise Automate] Create an authentication link for a specific user. Generates a temporary link that allows the user to authenticate without a password. Requires a valid user ID. |
cwa_create_user |
Pro | Write | [ConnectWise Automate] Create a new user in ConnectWise Automate. The JSON body should contain user details including name, email, and user class assignment. |
cwa_delete_user |
Pro | Write | [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. |
cwa_get_client_permissions |
Free | Read-only | [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. |
cwa_get_user |
Free | Read-only | [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. |
cwa_get_user_access |
Free | Read-only | [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. |
cwa_get_user_favorites |
Free | Read-only | [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. |
cwa_get_user_folders |
Free | Read-only | [ConnectWise Automate] Retrieve the folder structure visible to users. Returns folder hierarchy including scripts, searches, and groups. |
cwa_get_user_settings |
Free | Read-only | [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. |
cwa_list_external_credentials |
Free | Read-only | [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. |
cwa_list_user_permissions |
Free | Read-only | [ConnectWise Automate] List user permissions with optional filtering and pagination. Returns permission assignments across all users including role, scope, and access level. |
cwa_list_users |
Free | Read-only | [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. |
cwa_update_user |
Pro | Write | [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. |
cwa_change_user_password parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with the new password. Example: {"NewPassword":"SecureP@ss123"}. | |
userId |
string | yes | The ConnectWise Automate user ID. |
cwa_create_auth_link parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the auth link configuration. Example: {"ExpirationMinutes":60}. | |
userId |
string | yes | The ConnectWise Automate user ID. |
cwa_create_user parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the user to create. Example: {"Name":"jdoe","Email":"jdoe@contoso.com","UserClassId":1}. |
cwa_delete_user parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
userId |
string | yes | The ConnectWise Automate user ID to delete. |
cwa_get_client_permissions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | The ConnectWise Automate client ID. |
cwa_get_user parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
userId |
string | yes | The ConnectWise Automate user ID. |
cwa_get_user_access parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
userId |
string | yes | The ConnectWise Automate user ID. |
cwa_get_user_favorites parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
userId |
string | yes | The ConnectWise Automate user ID. |
cwa_get_user_settings parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
userId |
string | yes | The ConnectWise Automate user ID. |
cwa_list_external_credentials parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | The ConnectWise Automate client ID. |
cwa_list_user_permissions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_users parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Example: "Email like '%@contoso.com%'". Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_update_user parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. Example: {"Email":"newemail@contoso.com"}. | |
userId |
string | yes | The ConnectWise Automate user ID to update. |
User Classes
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_create_user_class |
Pro | Write | [ConnectWise Automate] Create a new user class in ConnectWise Automate. The JSON body should contain the class name and permission definitions. |
cwa_delete_user_class |
Pro | Write | [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. |
cwa_get_user_class |
Free | Read-only | [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. |
cwa_get_user_class_extensions |
Free | Read-only | [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. |
cwa_list_user_classes |
Free | Read-only | [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. |
cwa_update_user_class |
Pro | Write | [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. |
cwa_create_user_class parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the user class to create. Example: {"Name":"Tier 1 Technicians","Permissions":{"Computers":true}}. |
cwa_delete_user_class parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
userClassId |
string | yes | The ConnectWise Automate user class ID to delete. |
cwa_get_user_class parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
userClassId |
string | yes | The ConnectWise Automate user class ID. |
cwa_get_user_class_extensions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
userClassId |
string | yes | The ConnectWise Automate user class ID. |
cwa_list_user_classes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_update_user_class parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. Example: {"Name":"Senior Technicians"}. | |
userClassId |
string | yes | The ConnectWise Automate user class ID to update. |
Auditing
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_create_user_audit |
Pro | Write | [ConnectWise Automate] Create a new user audit record. The JSON body should contain the audit details including the action performed and any relevant context. |
cwa_list_user_audits |
Free | Read-only | [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. |
cwa_create_user_audit parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the audit record to create. Example: {"UserName":"admin","Action":"ConfigChange","Details":"Updated patch policy"}. |
cwa_list_user_audits parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Example: "UserName = 'admin'". Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
Clients
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_create_client |
Pro | Write | [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"}. |
cwa_delete_client |
Pro | Write | [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. |
cwa_get_client |
Free | Read-only | [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. |
cwa_get_client_extra_fields |
Free | Read-only | [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. |
cwa_list_client_documents |
Free | Read-only | [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. |
cwa_list_clients |
Free | Read-only | [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. |
cwa_replace_client |
Pro | Write | [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. |
cwa_update_client |
Pro | Write | [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. |
cwa_create_client parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the client to create. Must include 'Name'. Example: {"Name":"Contoso Ltd","City":"Seattle","State":"WA"}. |
cwa_delete_client parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | The ConnectWise Automate client ID to delete. |
cwa_get_client parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | The ConnectWise Automate client ID. |
cwa_get_client_extra_fields parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | The ConnectWise Automate client ID. |
cwa_list_client_documents parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | The ConnectWise Automate client ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_clients parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Example: "Name like '%Contoso%'". Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_replace_client parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | The ConnectWise Automate client ID to replace. | |
fieldsJson |
string | yes | Complete JSON object for the client. All required fields must be present. Example: {"Name":"Contoso Ltd","City":"Portland","State":"OR"}. |
cwa_update_client parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | The ConnectWise Automate client ID to update. | |
fieldsJson |
string | yes | JSON object with fields to update. Example: {"City":"Portland","State":"OR"}. |
Client Sub-Resources
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_create_client_license |
Pro | Write | [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. |
cwa_create_client_product_key |
Pro | Write | [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. |
cwa_delete_client_permissions |
Pro | Write | [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. |
cwa_list_client_licenses |
Free | Read-only | [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. |
cwa_list_client_permissions |
Free | Read-only | [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. |
cwa_list_client_product_keys |
Free | Read-only | [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. |
cwa_set_client_permissions |
Pro | Write | [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. |
cwa_update_client_permissions |
Pro | Write | [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. |
cwa_create_client_license parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | The ConnectWise Automate client ID. | |
fieldsJson |
string | yes | JSON object for the license to create. Example: {"ProductName":"Office 365","LicenseKey":"XXXXX-XXXXX","ExpirationDate":"2027-01-01"}. |
cwa_create_client_product_key parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | The ConnectWise Automate client ID. | |
fieldsJson |
string | yes | JSON object for the product key to create. Example: {"ProductName":"Windows Server 2025","ProductKey":"XXXXX-XXXXX-XXXXX","Notes":"DC license"}. |
cwa_delete_client_permissions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | The ConnectWise Automate client ID. | |
userClassId |
string | yes | The user class ID to delete permissions for. |
cwa_list_client_licenses parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | The ConnectWise Automate client ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_client_permissions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | The ConnectWise Automate client ID. | |
userClassId |
string | yes | The user class ID to retrieve permissions for. |
cwa_list_client_product_keys parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | The ConnectWise Automate client ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_set_client_permissions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | The ConnectWise Automate client ID. | |
fieldsJson |
string | yes | JSON object defining the permissions. Example: {"Computers":true,"Remoting":true,"Scripts":false}. | |
userClassId |
string | yes | The user class ID to set permissions for. |
cwa_update_client_permissions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | The ConnectWise Automate client ID. | |
fieldsJson |
string | yes | Complete JSON object for the permissions. All fields must be present. Example: {"Computers":true,"Remoting":true,"Scripts":true}. | |
userClassId |
string | yes | The user class ID to update permissions for. |
Locations
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_create_location |
Pro | Write | [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. |
cwa_delete_location |
Pro | Write | [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. |
cwa_list_locations |
Free | Read-only | [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. |
cwa_replace_location |
Pro | Write | [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. |
cwa_update_location |
Pro | Write | [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. |
cwa_create_location parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON 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"}. |
cwa_delete_location parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
locationId |
string | yes | The ConnectWise Automate location ID to delete. |
cwa_list_locations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Example: "ClientId = 5" or "Name like '%Main%'". Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_replace_location parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Complete 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"}. | |
locationId |
string | yes | The ConnectWise Automate location ID to replace. |
cwa_update_location parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. Example: {"Address":"456 Oak Ave","City":"Portland"}. | |
locationId |
string | yes | The ConnectWise Automate location ID to update. |
Location Extra Fields
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_delete_location_extra_field |
Pro | Write | [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. |
cwa_update_location_extra_field |
Pro | Write | [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. |
cwa_delete_location_extra_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
string | yes | The extra field ID to delete. | |
locationId |
string | yes | The ConnectWise Automate location ID. |
cwa_update_location_extra_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. Example: {"Value":"Updated notes"}. | |
id |
string | yes | The extra field ID to update. | |
locationId |
string | yes | The ConnectWise Automate location ID. |
Computers
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_create_computer_menu |
Pro | Write | [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. |
cwa_get_computer_alerts |
Free | Read-only | [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. |
cwa_get_computer_command_history |
Free | Read-only | [ConnectWise Automate] Retrieve command execution history for a specific computer. Returns past commands including type, status, and output. Requires a valid computer ID. |
cwa_list_computers |
Free | Read-only | [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. |
cwa_create_computer_menu parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the computer menu to create. Example: {"Name":"Run Cleanup","Command":"cleanup.bat","MenuType":1}. |
cwa_get_computer_alerts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_computer_command_history parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_computers parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Example: "OS like '%Windows%'". Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
Alert Suspensions
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_create_monitor_alert_suspension |
Pro | Write | [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. |
cwa_get_maintenance_alert_suspensions |
Free | Read-only | [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. |
cwa_get_monitor_alert_suspensions |
Free | Read-only | [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. |
cwa_get_template_alert_suspensions |
Free | Read-only | [ConnectWise Automate] Retrieve template-based alert suspensions for a specific computer. Returns suspension rules applied via alert templates. Requires a valid computer ID. |
cwa_create_monitor_alert_suspension parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
fieldsJson |
string | yes | JSON object for the monitor alert suspension. Example: {"MonitorId":123,"SuspendUntil":"2026-04-10T00:00:00Z"}. |
cwa_get_maintenance_alert_suspensions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_monitor_alert_suspensions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_template_alert_suspensions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
Computer Hardware
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_get_computer_bios |
Free | Read-only | [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. |
cwa_get_computer_chassis |
Free | Read-only | [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. |
cwa_get_computer_devices |
Free | Read-only | [ConnectWise Automate] Retrieve hardware devices attached to a specific computer. Returns device details including type, name, manufacturer, and status. Requires a valid computer ID. |
cwa_get_computer_drivers |
Free | Read-only | [ConnectWise Automate] Retrieve installed drivers for a specific computer. Returns driver details including name, version, provider, and date. Requires a valid computer ID. |
cwa_get_computer_drives |
Free | Read-only | [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. |
cwa_get_computer_memory_slots |
Free | Read-only | [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. |
cwa_get_computer_processors |
Free | Read-only | [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. |
cwa_get_computer_system_slots |
Free | Read-only | [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. |
cwa_get_computer_ups |
Free | Read-only | [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. |
cwa_get_computer_video_cards |
Free | Read-only | [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. |
cwa_get_drive_smart_data |
Free | Read-only | [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. |
cwa_get_computer_bios parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_computer_chassis parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_computer_devices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_computer_drivers parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_computer_drives parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_computer_memory_slots parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_computer_processors parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_computer_system_slots parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_computer_ups parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_computer_video_cards parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_drive_smart_data parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
driveId |
string | yes | The drive ID within this computer. |
Computer Software & Services
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_classify_service |
Pro | Write | [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. |
cwa_get_computer_printers |
Free | Read-only | [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. |
cwa_get_computer_services |
Free | Read-only | [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. |
cwa_get_computer_software |
Free | Read-only | [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. |
cwa_uninstall_software |
Pro | Write | [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. |
cwa_classify_service parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the classification. Example: {"Classification":"Critical","MonitorEnabled":true}. | |
serviceId |
string | yes | The service ID to classify. |
cwa_get_computer_printers parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_computer_services parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_computer_software parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_uninstall_software parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
softwareId |
string | yes | The software ID to uninstall from this computer. |
Computer OS & Networking
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_get_computer_monitors |
Free | Read-only | [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. |
cwa_get_computer_os |
Free | Read-only | [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. |
cwa_get_computer_sensors |
Free | Read-only | [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. |
cwa_get_computer_monitors parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_computer_os parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. |
cwa_get_computer_sensors parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
Computer Patching
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_get_computer_effective_patch_policy |
Free | Read-only | [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. |
cwa_get_computer_microsoft_updates |
Free | Read-only | [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. |
cwa_get_computer_patch_jobs |
Free | Read-only | [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. |
cwa_get_computer_patching_policies |
Free | Read-only | [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. |
cwa_get_computer_patching_stats |
Free | Read-only | [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. |
cwa_get_computer_effective_patch_policy parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. |
cwa_get_computer_microsoft_updates parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_computer_patch_jobs parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_computer_patching_policies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_computer_patching_stats parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. |
Third-Party Patches
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_get_computer_third_party_patches |
Free | Read-only | [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. |
cwa_get_computer_third_party_patches parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
Computer Scripts
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_execute_command |
Pro | Write | [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. |
cwa_get_computer_running_scripts |
Free | Read-only | [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. |
cwa_get_computer_script_history |
Free | Read-only | [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. |
cwa_schedule_computer_script |
Pro | Write | [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. |
cwa_execute_command parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
fieldsJson |
string | yes | JSON object for the command to execute. Example: {"Command":"ipconfig /all","CommandType":1,"TimeOut":30}. |
cwa_get_computer_running_scripts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_computer_script_history parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_schedule_computer_script parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
fieldsJson |
string | yes | JSON object for the scheduled script. Example: {"ScriptId":123,"Parameters":"param1=value1","RunDate":"2026-04-10T09:00:00Z"}. |
Computer Maintenance
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_get_computer_maintenance_modes |
Free | Read-only | [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. |
cwa_get_computer_scheduled_scripts |
Free | Read-only | [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. |
cwa_schedule_computer_task |
Pro | Write | [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. |
cwa_get_computer_maintenance_modes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_computer_scheduled_scripts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_schedule_computer_task parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The ConnectWise Automate computer ID. | |
fieldsJson |
string | yes | JSON object for the scheduled task. Example: {"TaskName":"Disk Cleanup","TaskType":1,"RunDate":"2026-04-10T02:00:00Z","Recurrence":"Weekly"}. |
Fleet-Wide Queries
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_list_global_chassis |
Free | Read-only | [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. |
cwa_list_global_drives |
Free | Read-only | [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. |
cwa_list_global_maintenance_modes |
Free | Read-only | [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. |
cwa_list_global_memory_slots |
Free | Read-only | [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. |
cwa_list_global_software |
Free | Read-only | [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. |
cwa_list_global_chassis parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_global_drives parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_global_maintenance_modes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_global_memory_slots parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_global_software parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
Alerts
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_delete_retired_asset |
Pro | Write | [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. |
cwa_list_alerts |
Free | Read-only | [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. |
cwa_list_retired_assets |
Free | Read-only | [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. |
cwa_delete_retired_asset parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
assetId |
string | yes | The retired asset ID to delete. |
cwa_list_alerts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_retired_assets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
Contacts
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_create_contact |
Pro | Write | [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. |
cwa_delete_contact |
Pro | Write | [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. |
cwa_get_contact |
Free | Read-only | [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. |
cwa_list_contacts |
Free | Read-only | [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. |
cwa_list_contacts_v1 |
Free | Read-only | [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.). |
cwa_list_system_contacts |
Free | Read-only | [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. |
cwa_update_contact |
Pro | Write | [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. |
cwa_create_contact parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the contact to create. Must include 'FirstName' and 'LastName'. Example: {"FirstName":"Jane","LastName":"Doe","Email":"jane@contoso.com","ClientId":5,"LocationId":1}. |
cwa_delete_contact parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contactId |
string | yes | The ConnectWise Automate contact ID to delete. |
cwa_get_contact parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contactId |
string | yes | The ConnectWise Automate contact ID. |
cwa_list_contacts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Example: "LastName like '%Smith%'". Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_contacts_v1 parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Example: "Email like '%@contoso.com%'". Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_system_contacts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_update_contact parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contactId |
string | yes | The ConnectWise Automate contact ID to update. | |
fieldsJson |
string | yes | Complete 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
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_get_ticket |
Free | Read-only | [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. |
cwa_list_tickets |
Free | Read-only | [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. |
cwa_get_ticket parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
ticketId |
string | yes | The ConnectWise Automate ticket ID. |
cwa_list_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Example: "Status = 'New'" or "ClientId = 5". Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
Scripts
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_copy_script |
Pro | Write | [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. |
cwa_create_script |
Pro | Write | [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. |
cwa_create_script_v1 |
Pro | Write | [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. |
cwa_delete_script |
Pro | Write | [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. |
cwa_delete_script_schedule |
Pro | Write | [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. |
cwa_get_script |
Free | Read-only | [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. |
cwa_list_running_scripts |
Free | Read-only | [ConnectWise Automate] List currently running scripts with optional filtering and pagination. Returns active script executions including computer, script name, status, and start time. |
cwa_list_script_schedules |
Free | Read-only | [ConnectWise Automate] List scheduled script executions with optional filtering and pagination. Returns schedule details including script name, target, frequency, and next run time. |
cwa_list_scripts |
Free | Read-only | [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. |
cwa_update_script |
Pro | Write | [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. |
cwa_update_script_schedule |
Pro | Write | [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. |
cwa_copy_script parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
scriptId |
string | yes | The ConnectWise Automate script ID to copy. |
cwa_create_script parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the script to create. Example: {"Name":"Patch Scan","FolderId":1,"ScriptType":1}. |
cwa_create_script_v1 parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the script to create. Example: {"Name":"Disk Cleanup","FolderId":1,"ScriptType":1}. |
cwa_delete_script parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
scriptId |
string | yes | The ConnectWise Automate script ID. |
cwa_delete_script_schedule parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
scheduledId |
string | yes | The ConnectWise Automate scheduled script ID. |
cwa_get_script parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
scriptId |
string | yes | The ConnectWise Automate script ID. |
cwa_list_running_scripts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_script_schedules parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_scripts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Example: "Name like '%Cleanup%'". Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_update_script parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with the full updated script. Example: {"Name":"Disk Cleanup v2","FolderId":1,"ScriptType":1}. | |
scriptId |
string | yes | The ConnectWise Automate script ID. |
cwa_update_script_schedule parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON Patch array. Example: [{"op":"replace","path":"/Enabled","value":false}]. | |
scheduledId |
string | yes | The ConnectWise Automate scheduled script ID. |
Script Folders
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_create_script_folder |
Pro | Write | [ConnectWise Automate] Create a new script folder. The JSON body defines the folder name and optional parent folder. Returns the created folder object. |
cwa_create_v2_script_folder |
Pro | Write | [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. |
cwa_delete_script_folder |
Pro | Write | [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. |
cwa_get_script_folder |
Free | Read-only | [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. |
cwa_get_script_folder_hierarchy |
Free | Read-only | [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. |
cwa_list_script_folders |
Free | Read-only | [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. |
cwa_update_script_folder |
Pro | Write | [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. |
cwa_create_script_folder parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the script folder to create. Example: {"Name":"Maintenance Scripts","ParentId":1}. |
cwa_create_v2_script_folder parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the script folder to create. Example: {"Name":"Automation Scripts","ParentId":1}. |
cwa_delete_script_folder parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
entityId |
string | yes | The ConnectWise Automate script folder entity ID. |
cwa_get_script_folder parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
entityId |
string | yes | The ConnectWise Automate script folder entity ID. |
cwa_list_script_folders parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Example: "Name like '%Maintenance%'". Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_update_script_folder parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
entityId |
string | yes | The ConnectWise Automate script folder entity ID. | |
fieldsJson |
string | yes | JSON Patch array. Example: [{"op":"replace","path":"/Name","value":"Renamed Folder"}]. |
Groups
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_add_group_computers |
Pro | Write | [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. |
cwa_add_group_network_devices |
Pro | Write | [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. |
cwa_create_group |
Pro | Write | [ConnectWise Automate] Create a new group. The JSON body defines the group name, parent, and configuration. Returns the created group object. |
cwa_delete_group |
Pro | Write | [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. |
cwa_get_group |
Free | Read-only | [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. |
cwa_list_group_computers |
Free | Read-only | [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. |
cwa_list_group_network_devices |
Free | Read-only | [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. |
cwa_list_groups |
Free | Read-only | [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. |
cwa_remove_group_computers |
Pro | Write | [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. |
cwa_remove_group_network_devices |
Pro | Write | [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. |
cwa_update_group |
Pro | Write | [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. |
cwa_add_group_computers parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with computer IDs to add. Example: {"ComputerIds":[1,2,3]}. | |
groupId |
string | yes | The ConnectWise Automate group ID. |
cwa_add_group_network_devices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with network device IDs to add. Example: {"NetworkDeviceIds":[1,2,3]}. | |
groupId |
string | yes | The ConnectWise Automate group ID. |
cwa_create_group parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the group to create. Example: {"Name":"Windows Servers","ParentId":1}. |
cwa_delete_group parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
groupId |
string | yes | The ConnectWise Automate group ID. |
cwa_get_group parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
groupId |
string | yes | The ConnectWise Automate group ID. |
cwa_list_group_computers parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
groupId |
string | yes | The ConnectWise Automate group ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_group_network_devices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
groupId |
string | yes | The ConnectWise Automate group ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_groups parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Example: "Name like '%Servers%'". Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_remove_group_computers parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
groupId |
string | yes | The ConnectWise Automate group ID. |
cwa_remove_group_network_devices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
groupId |
string | yes | The ConnectWise Automate group ID. |
cwa_update_group parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON Patch array. Example: [{"op":"replace","path":"/Name","value":"Renamed Group"}]. | |
groupId |
string | yes | The ConnectWise Automate group ID. |
Group Policies
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_delete_group_av_policies |
Pro | Write | [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. |
cwa_delete_group_template_properties |
Pro | Write | [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. |
cwa_get_group_av_policies |
Free | Read-only | [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. |
cwa_get_group_av_policy_data |
Free | Read-only | [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. |
cwa_get_group_template_properties |
Free | Read-only | [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. |
cwa_set_group_av_policies |
Pro | Write | [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. |
cwa_set_group_av_policy_data |
Pro | Write | [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. |
cwa_set_group_template_properties |
Pro | Write | [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. |
cwa_delete_group_av_policies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
groupId |
string | yes | The ConnectWise Automate group ID. |
cwa_delete_group_template_properties parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
groupId |
string | yes | The ConnectWise Automate group ID. |
cwa_get_group_av_policies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
groupId |
string | yes | The ConnectWise Automate group ID. |
cwa_get_group_av_policy_data parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
avPolicyId |
string | yes | The ConnectWise Automate AV template policy ID. | |
groupId |
string | yes | The ConnectWise Automate group ID. |
cwa_get_group_template_properties parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
groupId |
string | yes | The ConnectWise Automate group ID. |
cwa_set_group_av_policies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with AV template policy assignments. Example: {"AVTemplatePolicyId":1,"Enabled":true}. | |
groupId |
string | yes | The ConnectWise Automate group ID. |
cwa_set_group_av_policy_data parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
avPolicyId |
string | yes | The ConnectWise Automate AV template policy ID. | |
fieldsJson |
string | yes | JSON object with the full AV policy data. Example: {"ScanSchedule":"Daily","ExcludedPaths":[]}. | |
groupId |
string | yes | The ConnectWise Automate group ID. |
cwa_set_group_template_properties parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with template property values. Example: {"Properties":[{"Name":"Patch Policy","Value":"Enabled"}]}. | |
groupId |
string | yes | The ConnectWise Automate group ID. |
Monitors
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_get_collected_data |
Free | Read-only | [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. |
cwa_get_data_collection_settings |
Free | Read-only | [ConnectWise Automate] Retrieve data collection settings for the Automate server. Returns configuration for how monitoring data is collected, retained, and purged. |
cwa_get_monitor_statistics |
Free | Read-only | [ConnectWise Automate] Retrieve aggregated monitor statistics. Returns summary counts of monitors by status, type, and alert state across the Automate environment. |
cwa_list_internal_monitor_results |
Free | Read-only | [ConnectWise Automate] List internal monitor results with optional filtering and pagination. Returns monitor check results including status, last check time, and alert state. |
cwa_list_monitor_history |
Free | Read-only | [ConnectWise Automate] List monitor history with optional filtering and pagination. Returns historical monitor check results including timestamps, status changes, and alert triggers. |
cwa_list_sensor_checks |
Free | Read-only | [ConnectWise Automate] List sensor checks with optional filtering and pagination. Returns sensor check definitions including type, interval, and threshold configuration. |
cwa_get_collected_data parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Example: "ComputerId = 123". Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_internal_monitor_results parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_monitor_history parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Example: "MonitorId = 42". Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_sensor_checks parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
Patching
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_deploy_all_approved_patches |
Pro | Write | [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. |
cwa_deploy_all_security_patches |
Pro | Write | [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. |
cwa_list_approval_policies |
Free | Read-only | [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. |
cwa_list_group_patching_policies |
Free | Read-only | [ConnectWise Automate] List group patching policies with optional filtering and pagination. Returns policy summaries including group assignments, patch windows, and reboot settings. |
cwa_list_microsoft_update_policies |
Free | Read-only | [ConnectWise Automate] List Microsoft update policies with optional filtering and pagination. Returns policy details including update classifications, products, and approval rules. |
cwa_list_patch_history |
Free | Read-only | [ConnectWise Automate] List patch installation history with optional filtering and pagination. Returns patch records including KB article, install date, status, and target computer. |
cwa_list_third_party_update_policies |
Free | Read-only | [ConnectWise Automate] List third-party update policies with optional filtering and pagination. Returns policy details including vendor, product, and approval settings. |
cwa_reattempt_failed_patches |
Pro | Write | [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. |
cwa_set_patch_pilot_stage |
Pro | Write | [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. |
cwa_set_patch_production_stage |
Pro | Write | [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. |
cwa_set_patch_test_stage |
Pro | Write | [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. |
cwa_deploy_all_approved_patches parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with deployment parameters. Example: {"GroupId":1,"RebootIfNeeded":true}. |
cwa_deploy_all_security_patches parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with deployment parameters. Example: {"GroupId":1,"RebootIfNeeded":true}. |
cwa_list_approval_policies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_group_patching_policies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_microsoft_update_policies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_patch_history parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Example: "Status = 'Failed'". Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_third_party_update_policies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_reattempt_failed_patches parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with retry parameters. Example: {"GroupId":1,"RebootIfNeeded":true}. |
cwa_set_patch_pilot_stage parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with pilot stage parameters. Example: {"PatchIds":[1,2,3],"GroupId":1}. |
cwa_set_patch_production_stage parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with production stage parameters. Example: {"PatchIds":[1,2,3],"GroupId":1}. |
cwa_set_patch_test_stage parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with test stage parameters. Example: {"PatchIds":[1,2,3],"GroupId":1}. |
Network Devices
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_create_network_device |
Pro | Write | [ConnectWise Automate] Create a new network device record. The JSON body should contain device details including name, IP address, and location. |
cwa_get_network_device |
Free | Read-only | [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. |
cwa_list_network_devices |
Free | Read-only | [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. |
cwa_list_routers |
Free | Read-only | [ConnectWise Automate] List routers with optional filtering and pagination. Returns router details including IP address, location, and discovery status. |
cwa_update_network_device |
Pro | Write | [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. |
cwa_create_network_device parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the network device to create. Example: {"Name":"Core Switch","IpAddress":"10.0.0.1","LocationId":1}. |
cwa_get_network_device parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
deviceId |
string | yes | The ConnectWise Automate network device ID. |
cwa_list_network_devices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Example: "DeviceType = 'Router'". Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_routers parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Condition filter expression. Omit for no filtering. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_update_network_device parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
deviceId |
string | yes | The ConnectWise Automate network device ID to update. | |
fieldsJson |
string | yes | JSON object with fields to update. Example: {"Name":"Core Switch v2","IpAddress":"10.0.0.2"}. |
Batch Operations
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_batch_execute_script |
Pro | Write | [ConnectWise Automate] Execute a script across multiple computers simultaneously. Provide computer IDs and script ID in the JSON body. |
cwa_batch_run_device_detection |
Pro | Write | [ConnectWise Automate] Run network device detection across multiple probes simultaneously. |
cwa_batch_schedule_script |
Pro | Write | [ConnectWise Automate] Schedule a script to run across multiple computers at a specified time. |
cwa_batch_send_to_search |
Pro | Write | [ConnectWise Automate] Send batch results to a saved search for further processing. |
cwa_batch_execute_script parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with script execution details including target computer IDs and script ID. |
cwa_batch_run_device_detection parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with probe command details for device detection. |
cwa_batch_schedule_script parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with scheduling details including target computer IDs, script ID, and schedule time. |
cwa_batch_send_to_search parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with search target details. |
Probes
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_create_probe_config |
Pro | Write | [ConnectWise Automate] Create a new probe configuration for a location. Use cwa_list_locations to find location IDs. |
cwa_delete_probe_config |
Pro | Write | [ConnectWise Automate] Delete a probe configuration for a location. |
cwa_delete_probe_push_credentials |
Pro | Write | [ConnectWise Automate] Delete agent push credentials for a probe. |
cwa_enable_probe |
Pro | Write | [ConnectWise Automate] Enable probe functionality on a computer. The computer must be an existing managed agent. Use cwa_list_computers to find computer IDs. |
cwa_get_probe_config |
Free | Read-only | [ConnectWise Automate] Get probe configuration for a location. Probe configs are scoped to locations — use cwa_list_locations to find location IDs. |
cwa_get_probe_push_credentials |
Free | Read-only | [ConnectWise Automate] Get agent push credentials for a probe by its probe configuration ID. |
cwa_get_probe_snmp_config |
Free | Read-only | [ConnectWise Automate] Get SNMP configuration for a probe by its probe configuration ID. |
cwa_list_probe_events |
Free | Read-only | [ConnectWise Automate] List network probe discovery events with optional filtering and pagination. |
cwa_set_probe_push_credentials |
Pro | Write | [ConnectWise Automate] Set agent push credentials for a probe. Replaces the current credentials entirely. |
cwa_update_probe_config |
Pro | Write | [ConnectWise Automate] Update a probe configuration for a location. Supports JSON Patch format. |
cwa_update_probe_snmp_config |
Pro | Write | [ConnectWise Automate] Update SNMP configuration for a probe. Use cwa_get_probe_snmp_config to see current values. |
cwa_upgrade_probe |
Pro | Write | [ConnectWise Automate] Upgrade the probe agent at a location to the latest version. |
cwa_create_probe_config parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with probe configuration fields. | |
locationId |
string | yes | The location ID to create the probe configuration under. |
cwa_delete_probe_config parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
locationId |
string | yes | The location ID that owns the probe configuration. |
cwa_delete_probe_push_credentials parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
configId |
string | yes | The probe configuration ID. |
cwa_enable_probe parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
computerId |
string | yes | The computer ID to enable as a probe. | |
fieldsJson |
string | no | "" | JSON object with probe enable options (can be empty ). |
cwa_get_probe_config parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Filter condition string. |
locationId |
string | yes | The location ID to get probe configuration for. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_get_probe_push_credentials parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
configId |
string | yes | The probe configuration ID. |
cwa_get_probe_snmp_config parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
configId |
string | yes | The probe configuration ID. |
cwa_list_probe_events parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Filter condition string. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_set_probe_push_credentials parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
configId |
string | yes | The probe configuration ID. | |
fieldsJson |
string | yes | JSON object with agent push credential fields. |
cwa_update_probe_config parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object or JSON Patch array with update fields. | |
locationId |
string | yes | The location ID that owns the probe configuration. |
cwa_update_probe_snmp_config parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
configId |
string | yes | The probe configuration ID. | |
fieldsJson |
string | yes | JSON object or JSON Patch array with SNMP configuration updates. |
cwa_upgrade_probe parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | no | "" | JSON object with upgrade options (can be empty ). |
locationId |
string | yes | The location ID whose probe should be upgraded. |
Probe Lookups
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_list_event_levels |
Free | Read-only | [ConnectWise Automate] List probe event level definitions. Returns the available severity/type classifications for probe events. |
cwa_list_network_port_options |
Free | Read-only | [ConnectWise Automate] List available network port options for probe status scans. |
cwa_list_scan_frequencies |
Free | Read-only | [ConnectWise Automate] List available scan frequency options for probe configurations. |
cwa_list_snmp_encryption_methods |
Free | Read-only | [ConnectWise Automate] List available SNMP encryption methods for probe network discovery. |
cwa_list_snmp_hash_methods |
Free | Read-only | [ConnectWise Automate] List available SNMP hash methods for probe authentication. |
Searches
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_create_search |
Pro | Write | [ConnectWise Automate] Create a saved search. |
cwa_create_search_folder |
Pro | Write | [ConnectWise Automate] Create a search folder. |
cwa_list_search_folders |
Free | Read-only | [ConnectWise Automate] List search folder structure with optional filtering and pagination. |
cwa_list_searches |
Free | Read-only | [ConnectWise Automate] List saved searches with optional filtering and pagination. |
cwa_create_search parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with search definition fields. |
cwa_create_search_folder parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with search folder fields. |
cwa_list_search_folders parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Filter condition string. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_searches parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Filter condition string. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
Remote Agents
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_create_remote_agent_schedule |
Pro | Write | [ConnectWise Automate] Create a remote agent schedule. |
cwa_create_remote_agent_template |
Pro | Write | [ConnectWise Automate] Create a remote agent template. |
cwa_list_remote_agent_schedules |
Free | Read-only | [ConnectWise Automate] List remote agent schedules with optional filtering and pagination. |
cwa_list_remote_agent_templates |
Free | Read-only | [ConnectWise Automate] List remote agent templates with optional filtering and pagination. |
cwa_create_remote_agent_schedule parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with remote agent schedule fields. |
cwa_create_remote_agent_template parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with remote agent template fields. |
cwa_list_remote_agent_schedules parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Filter condition string. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_remote_agent_templates parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Filter condition string. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
Data Views & Misc
| Tool | Plan | Access | Description |
|---|---|---|---|
cwa_get_user_profile |
Free | Read-only | [ConnectWise Automate] Get the current user's profile configuration. |
cwa_list_data_views |
Free | Read-only | [ConnectWise Automate] List available data view definitions with optional filtering and pagination. |
cwa_list_drive_statistics |
Free | Read-only | [ConnectWise Automate] Get drive statistics with daily/weekly/monthly/yearly granularity. |
cwa_list_event_logs |
Free | Read-only | [ConnectWise Automate] List system event log entries with optional filtering and pagination. |
cwa_list_maintenance_windows |
Free | Read-only | [ConnectWise Automate] List maintenance window definitions with optional filtering and pagination. |
cwa_list_data_views parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Filter condition string. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_drive_statistics parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Filter condition string. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_event_logs parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Filter condition string. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |
cwa_list_maintenance_windows parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
condition |
string | no | null | Filter condition string. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 200 | Results per page (default 200, max 1000). |