Skip to content

Latest commit

 

History

History
369 lines (338 loc) · 84.7 KB

File metadata and controls

369 lines (338 loc) · 84.7 KB

Kaseya VSA integration

{% hint style="info" %} If you’re new to integrations in Rewst, read through our introductory integration documentation here. {% endhint %}

What does the Kaseya VSA integration do?

Our Kaseya VSA integration enables the automation of remote monitoring and management. Use the Kaseya VSA API within Rewst workflows to obtain asset inventory, execute commands and run procedures on endpoints.

Set up the Kaseya VSA integration

Set up steps in Kaseya VSA

  1. Log in to Kaseya VSA
  2. Navigate to System > Server Management > OAuth Clients.
  3. Select Register Client and supply the following:
    • Client Name: RewstAPI
    • Redirect URL (From Rewst Kaseya integration page)
    • Email: email@address.com
  4. Click Save.
  5. Copy the information from the dialogue and store it somewhere secure. You'll need this information for further steps in Rewst.

Set up steps in Rewst

  1. Navigate to Marketplace > Integrations in the left side menu of your Rewst platform.

  2. In the Integrations page, search for the Kaseya VSA integration.

  3. Under Parameters, enter the information copied from Kaseya into the relevant fields:

    1. Hostname: i.e. rmm.company.com
    2. Client ID: From Kaseya OAuth page
    3. Client Secret: From Kaseya OAuth page
  4. Click Save Configuration.

  5. Rewst will do a quick validation of your input. Once completed, you'll see a new section beneath the configuration form for organization mapping. Complete your mapping as desired.

{% hint style="success" %} If your VSA is behind a firewall, WAF has IIS Re-write rules, or has the Kaseya edge firewall configuration in place you will need to add 3.139.170.31 to the allowed list (tcp/443). {% endhint %}

Rewst agent procedure import

To perform actions on agent end points in Rewst, you'll need to import the file Procedure RewstPoshCommand.xml into the VSA.

{% hint style="warning" %} It is important that you do not change or modify this file in any way. Please do not rename the procedure once imported. {% endhint %}

  1. Download the file Procedure Rewst (Powershell).xml.

{% file src="../../../.gitbook/assets/Procedure Rewst (Powershell).xml" %}

  1. Log in to your VSA.
  2. Navigate to System > Server Management > Import Center.
  3. Select New Import.
  4. Name it Rewst (Powershell), and point it to the Procedure Rewst (Powershell).xml file.
  5. Click Process.
  6. Click Save.

{% hint style="success" %} Got an idea for a new Integration? Rewst is constantly adding new integrations to our integrations page. Submit your idea or upvote existing ideas here in our Canny feedback collector. {% endhint %}

Use custom PowerShell scripts with your RMM integration

If you're writing custom PowerShell scripts to use and be run with your RMM integration, you'll need to manually add webhook calls. Any custom script will time out if used without first adding the webhook calls. The use of standard built-in Rewst scripts with your RMM does not require you to add the calls.

The webhook calls everyone doing this custom scripting should use will always be as follows.


### Send all the data back to RewstyRewst ###


$postData = $PS_Results | ConvertTo-Json
Invoke-RestMethod -Method 'Post' -Uri $post_url -Body $postData -ContentType 'application/json; 
charset=utf-8'

Actions and endpoints

{% hint style="info" %} For more on how actions work in Rewst, check out our introductory actions documentation here. {% endhint %}

Category Action Description
Agent Info Get Agent Info Retrieve agent info for a particular organization
Agent Procedure List Agent Procedures Returns an array of agent procedures
Agent Procedure List Agent Procedures With Prompts Returns an array of agent procedures with any relevant script prompts
Agent Procedure List User Portal Agent Procedures Returns an array of agent procedures displayed on the user portal
Agent Procedure List Scheduled Agent Procedures Returns an array of agent procedure schedule records for a specified agent
Agent Procedure List Agent Procedure Prompts Returns an array of script prompts for a specified agent procedure
Agent Procedure Run Agent Procedure Runs an agent procedure immediately for a single agent
Agent Procedure Run Agent Procedure and Get ID Runs a procedure for the specified agent and returns the resulting script assignment ID
Agent Procedure Schedule Agent Procedure Schedules an agent procedure for a single agent
Agent Procedure Cancel Scheduled Agent Procedure Cancels a scheduled agent procedure running on an agent machine
Agent Procedure List Agent Procedure History Returns an array of agent procedure runtime history records
Alarm List Alarms Returns an array of all alarms within your VSA user's scope
Alarm Get Alarm Returns the details of a specified alarm
Alarm Close Alarm Closes a specified alarm
Alert Create Agent Alert Creates a new agent alert for a given alert ID
Alert Create System Alert Creates a new system alert for a given alert ID
Alert Get Alarm By Alert Tracking ID Returns the alarm for a given alert tracking ID
Alert List Alert Definitions Returns an array of alert definitions
Alert Update Alert Definitions Updates the properties of one or more existing alert definitions
Alert Create Alert Definitions Creates one or more alert definitions
Alert Delete Alert Definitions Deletes a given list of alert definitions
Asset Management List Assets Returns an array of summary asset records
Asset Management List Agents Returns an array of agent records
Asset Management List Agent Active Admins Returns a list of the agents with one or more active admins
Asset Management List Agent Portal Access Returns an array of the credentials used by agents to access portal
Asset Management List Agents On Network Returns an array of agents in a specified Discovery network
Asset Management List Temporary Agents Returns an array of agents that are only temporarily available
Asset Management List Agents in Agent View Returns an array of agent records in the selected view
Asset Management List Connection Gateway IPs Returns all unique values for the ConnectionGatewayIP for Agents
Asset Management List Asset Types Returns an array of asset type records
Asset Management Get Asset Returns a single detailed asset record
Asset Management Delete Asset Deletes a single asset
Asset Management Get Audit Summary Returns the audit summary for the agent machine
Asset Management Get Agent Returns a single agent record
Asset Management Update Agent Temp Directory Updates the temp directory for an agent
Asset Management List Agent Settings Returns an array of settings for an agent
Asset Management Get Agent 2FA Settings Returns Two Factor Authentication settings for a specified Agent ID
Asset Management Get Agent User Profile Returns the user profile settings for an agent
Asset Management Update Agent User Profile Updates the user profile settings for an agent
Asset Management List Agent User Profiles Returns the user profile settings for all agents
Asset Management Update Checkin Control Updates checkin control settings for an agent
Asset Management Delete Agent Deletes an agent. Provides an option to wait for the agent to uninstall on the managed machine first.
Asset Management List Custom Fields Returns an array of custom fields available to assets
Asset Management Create Custom Field Adds a new agent custom field
Asset Management Rename Custom Field Updates the name of an existing custom field
Asset Management Delete Custom Field Deletes a custom field
Asset Management List Agent Custom Fields Returns an array of custom fields for a specified agent
Asset Management Update Agent Custom Field Value Updates the value of an existing custom field for a specified agent
Asset Management List Agent Install Packages Returns an array of agent install package records
Asset Management Create Agent Install Package Adds an agent install package record
Asset Management List Agent Uptime Returns an array of agent uptime records
Asset Management Delete Agent Install Package Deletes an agent install package
Asset Management Rename Agent Renames the specified agent
Asset Management Create Agent Note Adds a note to the specified agent associated with the current user
Asset Management List Agent Notes Returns an array of agent notes
Asset Management Update Agent Note Updates a note for an agent
Asset Management Delete Agent Note Deletes an agent note
Asset Management Upgrade Agent Version Upgrades the version for a specified agent
Asset Management Get Agent Scheduled Update Gets the scheduled update for an agent
Asset Management Promote Device To Asset Promotes a device to an asset
Asset Management Demote Asset To Device Demotes an asset to a device
Asset Management Suspend Agent Updates suspended status for a given list of agents
Audit List Audit Summaries Returns an array of audit summary records
Audit Run Baseline Audit Runs a baseline audit immediately for a single agent. A baseline audit shows the configuration of the system in its original state. Typically a baseline audit is performed when a system is first set up.
Audit Schedule Baseline Audit Schedules a baseline audit for a single agent. A baseline audit shows the configuration of the system in its original state. Typically a baseline audit is performed when a system is first set up.
Audit Run Latest Audit Runs a latest audit immediately for a single agent. The latest audit shows the configuration of the system as of the last audit. Once per day is recommended.
Audit Schedule Latest Audit Schedules a latest audit for a single agent. The latest audit shows the configuration of the system as of the last audit. Once per day is recommended.
Audit Run SysInfo Audit Runs a sysinfo audit immediately for a single agent. The sysinfo audit shows all DMI / SMBIOS data of the system as of the last system info audit. This data seldom changes and typically only needs to be run once.
Audit Schedule SysInfo Audit Schedules a sysinfo audit for a single agent. The sysinfo audit shows all DMI / SMBIOS data of the system as of the last system info audit. This data seldom changes and typically only needs to be run once.
Audit List Installed Applications Returns an array of installed applications on the agent machine
Audit List Security Products Returns an array of security products installed on the agent machine
Audit List PCI and Disks Returns an array of disk drives and pci devices on the agent machine
Audit List Printers Returns an array of printers and ports configured on an agent machine
Audit List Agent Disk Volumes Returns an array of disk volumes on the agent machine
Audit List All Disk Volumes Returns an array of disk volumes for all agent machines
Audit Get Audit Summary Returns the audit summary for a specified agent machine
Audit Get Purchase And Warranty Expiration Dates Returns the purchase date and warranty expiration date for a single agent
Audit Update Purchase and Warranty Expiration Dates Updates the purchase date and warranty expiration date for a single agent
Audit List Disk Partitions Returns an array of disk partitions for a specified agent
Audit List Disk Shares Returns an array of disk shared for a specified agent
Auth Anvil Update Auth Anvil SSO Cert Updates the certificate used by Auth Anvil to process SSO
Auth Anvil Delete Auth Anvil SSO Cert Deletes the certificate used by Auth Anvil to process SSO
Core Get Tenant Returns properties for the tenant partition your API authentication provides access to in the VSA
Core Create Notification Adds a single notification record
Core List Functions Returns a count and array of all function IDs
Core List Functions For Module Returns a count and array of all function IDs for a specified module ID
Core Is Module Installed Returns true or false, based on whether the specified module ID is installed
Core Is Module Activated Returns true or false, based on whether the specified module ID is activated
Core Send Email Sends an email to a specified recipient
Core Get Environment Returns system-wide properties of the VSA. No authentication is required
Department List Departments Returns an array of department records for a specified organization
Department Create Department Adds a single department record to a specified organization
Department Get Department Returns a single department record for a specified department
Department Update Department Updates a single department record
Department Delete Department Deletes a single department record
Deploy Page Customization Get Deploy Page Customization Returns the logo, title and description displayed by the deployment page for a specified tenant partition
Documents List Documents Returns an array of documents from the Audit > Documents page
Documents List Files Returns an array of files on the Agent Procedures > Get File page
Documents Get File Returns a file from the Agent Procedures > Get File page
Documents Get Document Returns a document from the Audit > Documents page
Documents Upload Document Uploads a file from your local computer or network to the Audit > Documents page for a specified agent
Documents Delete Document Deletes a single document on the Audit > Documents page
Documents Delete File Deletes a file on the Agent Procedures > Get File page
Documents Create Document Folder Adds documents folder on the Audit > Documents page
Documents Rename Document Rename a single document on the Audit > Documents page
Documents Move Document Moves a document from one folder to another folder on the Audit > Documents page
Documents List Document Services Audits Returns an array of services audits performed against documents
Documents List Distinct Services Names Returns an array of distinct services names
Documents List Volume Labels Returns an array of volume labels
Documents List Distinct Volume Labels Returns an array of distinct volume labels
Documents List Custom Extensions Returns an array of the files and folders in a folder of an agent's custom extension repository
Documents Add Custom Extension Folder Adds a folder to the path of a specified agent's custom extension repository
Documents Download File From Custom Extensions Returns the file at the specified custom extesions path
Documents Upload Custom Extension File Uploads a file from your local computer or network to the custom extension repository path of a specified agent
Documents Delete Custom Extensions Folder Deletes a folder in an agent's custom extension repository
Documents Get Custom Extensions Endpoint Ref ID Returns the Endpoint Ref ID for the custom extensions file at the specified path
Event Log List Event Logs Returns an array of event log entries
File Get Storage File Contents Returns the file contents of a remote control recording in the body of the response
Generic Request Kaseya API Request Generic action for making authenticated requests against the Kaseya API
Info Center List Inbox Messages Gets all inbox messages from info center
Info Center Set Message as Read/Unread Sets the IsRead field on messages
Info Center Delete Message Deletes a message
Last Backup Status Get Cloud Backup Server Statuses Returns the backup status of each physical server installed with Cloud Backup
Last Backup Status Get Cloud Backup Workstation Statuses Returns the backup status of each physical workstation installed with Cloud Backup
Last Backup Status Get Virtual Machine Cloud Backup Statuses Returns an array of cloud backup statuses for virtual machines
Last Backup Status List Cloud Backup Statuses By Org Returns the cloud backup statuses for a given Org
Legacy Ticketing List Legacy Tickets Returns an array of tickets
Legacy Ticketing Create Legacy Ticket Adds a new ticket
Legacy Ticketing Get Legacy Ticket Returns a single ticket
Legacy Ticketing Add Legacy Ticket Note Adds a note to a ticket
Legacy Ticketing Get Requested Legacy Ticket Returns the ticket created by a ticket request
Legacy Ticketing List Legacy Ticket Notes Returns the notes of a ticket
Machine Group List Machine Groups Returns an array of machine group records for all organizations
Machine Group List Machine Groups in Organization Returns an array of machine group records for an organization ID
Machine Group Get Machine Group Returns one machine group record
Machine Group Create Machine Group Adds a single machine group record to a specified organization
Machine Group Update Machine Group Updates a single machine group record
Machine Group Delete Machine Group Deletes a single machine group record
Machine Group Add Machine Group To Scope Adds a machine group to a scope
Machine Notify Policy Get Remote Control Notify Policy Returns the remote control notify policy for an agent machine
Navigation Get Setting - Classic UI Enabled Returns whether or not the Classic UI is enabled for navigation
Navigation List Navigation - Modules Returns an array of modules available in the UI navigation bar
Navigation List Navigation - Third Party Apps Returns an array of third party apps available in the UI navigation bar
Navigation Get Agents Status Returns a count of the agents in various states, as displayed in the UI header
Navigation Get Navigation Header Returns the title and image used in the UI header
Navigation List UI Alerts Returns an array of the alerts shown in the UI header
Navigation Delete UI Alerts Removes an alert from the UI
Navigation Mark UI Alert As Read Updates a list of UI alerts to be shown as either read or unread
Navigation List UI Notifications Returns an array of the notifications shown in the UI
Navigation Update UI Notification Properties Update read status or snooze notifications shown in the UI
Navigation Delete UI Notification Removes a notification from the UI
Navigation Perform Notification Action Performs the action associated with a given UI notification
Navigation List Online Admins Returns an array of admin users currently logged in to the UI
Org List Organizations Returns all organizations for a particular Kaseya VSA instance
Org Create Organization Creates a single organization record
Org List Networks For Org ID(s) Retrieves a list of networks for a given list of Organization IDs
Org Get Organization Retrieve a single Organization
Org Update Organization Updates a single organization
Org Delete Organization Deletes a single Organization
Org Add Org To Scope Adds an Organization to a specific Scope
Org List Organization Locations Retrieves a list of Organization Locations
Org List Organization Types Retrieves a list of Organization Types
Patch Management Run Patch Scan Scans an agent machine immediately for missing patches
Patch Management Run Patch Update Runs a patch update immediately
Patch Management Schedule Patch Scan Schedules a scan on an agent machine for missing patches
Patch Management Cancel Scheduled Patch Cancels a scheduled patch for an agent machine
Patch Management Delete Patch Deletes a patch
Patch Management Remove Patch Ignore Removes the Ignore setting for a missing patch for an agent machine
Patch Management Set Patch Ignore Sets the Ignore setting for missing patches for an agent machine. The request must include an array of PatchIds to specify which patches are being ignored.
Patch Management Get Patch Status Returns the patch status of an agent machine
Patch Management Get Patch History Returns the patch history for an agent
Patch Management List Missing Patches Returns an array of missing patches on an agent machine, with denied patches either included or excluded
Policy Settings Get One Click Access Policy Setting Returns the value of the one click access policy for a given agent
Protection Status List Anti-Virus Protection Statuses Returns an array of Anti-Virus protection statuses
Protection Status List Anti-Malware Protection Statuses Returns an array of Anti-Malware protection statuses
Protection Status List Anti-Virus Protection Statuses By Org Returns an array of Anti-Virus protection statuses for a specified organization
Protection Status List Anti-Malware Protection Statuses By Org Returns an array of Anti-Malware protection statuses for a specified organization
Quick Launch Get Ask Before Running Setting Returns the setting for the 'Ask before executing' checkbox on the Quick View dialog. This checkbox is set individually for each VSA user and is applied only when running a quicklaunch agent procedure.
Quick Launch Set Ask Before Running Setting Sets the value of the 'Ask before executing' checkbox on the Quick View dialog. This checkbox is set individually for each VSA user and is applied only when running a quicklaunch agent procedure.
Quick Launch Update Quick Launch Agent Procedure Updates a quick launch agent procedure
Quick Launch Delete Quick Launch Agent Procedure Deletes a quick launch agent procedure
Quick Launch List Quick Launch Agent Procedures Returns an array of agent procedures that can be "quick launched" from the Quick View window
Quick View List Credentials Returns an array of credentials for an agent
Quick View List Startup Apps Returns an array of startup apps on the agent machine
Quick View List Local User Group Members Returns an array of local users in each local user group on the agent machine
Quick View List Add/Remove Programs Returns an array of program entries in the add/remove list of Windows machines
Quick View List Local User Groups Returns an array of local user groups on the agent machine
Quick View List Software Licenses Returns an array of licenses used by the agent machine
Quick View List User Accounts Returns an array of user accounts on the agent machine
Rest Get Third Party App Status Returns the status of third party apps in a tenant
Rest Enable/Disable Third Party Apps Enables or disables third party apps in a tenant
Rest Create Third Party Notification Adds a notification to display to admins when they log into a tenant
Rest List Third Party App Notifications Returns an array of third party notifications for a specified app
Rest Get Third Party App Notification Returns a single third party notification
Rest Delete Third Party App Notification Deletes a third party app notification message
Role List User Roles Returns an array of user role records
Role Create User Role Adds a user role record
Role Get User Role Returns a single user role record
Role Delete User Role Deletes a single user role
Role List User Role Types Returns an array of user roletype records
Role Get User Role Type Returns a single user roletype record
Role Add User To Role Adds a user to a user role
Scope List Scopes Retrieve a list of scopes available in VSA
Scope Create Scope Create a new Scope in Kaseya VSA
Scope Get Scope Get a specific Scope by ID
Scope Delete Scope Deletes a Scope within VSA
Scope Add User To Scope Adds a user to the given scope by ID
Server Management List Whitelisted File Types Returns an array of the allowed file types in the VSA
Service Desk List Service Desks Returns an array of service desk definitions
Service Desk List Service Desk Tickets Returns an array of tickets for a specified service desk
Service Desk List Service Desk Ticket Status Returns an array of ticket statuses for a specified service desk
Service Desk List Service Desk Ticket Notes Returns an array of notes for a specified service desk ticket
Service Desk Add Service Desk Ticket Note Adds a note to a specified service desk ticket
Service Desk Get Service Desk Ticket Custom Field Value Returns the value of a custom field in a service desk ticket
Service Desk Update Service Desk Custom Field Value Updates the value of a custom field in a service desk ticket
Service Desk Update Service Desk Ticket Priority Updates the priority of a service desk ticket
Service Desk Update Service Desk Ticket Status Updates the status of a service desk ticket
Service Desk List Service Desk Priorities Returns an array of priorities for a specified service desk
Service Desk List Service Desk Ticket Categories Returns an array of ticket categories for a specified service desk
Service Desk Get Service Desk Ticket Returns a particular ticket
Service Desk List Service Desk Custom Fields Returns an array of custom fields for a specified service desk
Service Desk Assign Staff to Ticket Assigns a staff record to a service desk ticket
Staff List Staff Returns an array of staff records for all organizations
Staff Get Staff Returns a single staff record
Staff Update Staff Updates a single staff record
Staff Delete Staff Deletes a single staff record
Staff List Staff in Organization Returns an array of staff records for a single org
Staff List Staff in Department Returns an array of staff records for a single department
Staff Add Staff Adds a single staff record to a single department
System Log List System Logs Returns an array of system logs
Temporary Agent Get Temporary Agent Config Returns the configuration used for temporary agents
Temporary Agent Close Temporary Agent Removes the temporary agent with the given GUID
Temporary Agent Create Temporary Agent Starts a new temporary agent session
Temporary Agent Add Temporary Agent Notes Add notes to a given temporary agent
Temporary Agent Temporary Agent Send Email Sends an email to given temporary agent
Temporary Agent Update Temporary Agent Update the name or attributes of a temporary agent
Temporary Agent Create Agent Package Link Create a package link for a temporary agent
Tenant Management List Tenants Returns an array of tenant partitions in the VSA
Tenant Management List Module Licenses for Tenant Returns an array of module licenses for a specified Tenant ID
Tenant Management List Module Licenses Returns an array of module licenses for a specified Module ID
Tenant Management Get Tenant Returns the activated modules, activated roletypes, and other properties of a single tenant partition
Tenant Management Rename Tenant Renames the tenant partition
Tenant Management Create Tenant Adds a tenant partition, including activated modules, activated roletypes, and license limits
Tenant Management Delete Tenant Removes a tenant partition
Tenant Management Deactivate Tenant Deactivates a tenant partition instead of deleting it
Tenant Management Activate Modules Activates selected modules for a specified tenant
Tenant Management Deactivate Module Removes a module from a tenant partition
Tenant Management Set Tenant License Limit Updates a selected license within a specified tenant. Typically only the Limit field is updated.
Tenant Management Set Module Usage Type Sets the usage type for a module in a tenant ID. A usage type, if available for a module, enables a specialized feature in a module.
Tenant Management Activate Role Types Activates selected role types for a specified tenant
Tenant Management Deactivate Role Type Removes a roletype from a tenant partition
Tenant Management Set Role Type Limits Sets the maximum number of users allowed for a given role type within the tenant partition
Tenant Management List Role Types Returns an array of funclist entries for each roletype
Tenant Management Create Role Type Adds a roletype and an array of funclist entries
Tenant Management Get Role Type Returns an array of funclist entries for a specified roletype
Tenant Management Delete Role Type Removes a roletype from the entire VSA
Tenant Management Get Default Setting Retrieve the default value for a given setting
Tenant Management Get Logon Policy Retrieve logon policy for tenants
User List Users Returns an array of user account records
User Create User Adds a single user account record
User Get User Get a single user account record
User Get Current User Returns the currently authenticated user account record
User Get User UI Mode Get UI Mode for currently authenticated user
User Update User Updates a single user account record
User Enable User Enables a single user account record
User Disable User Disables a single user account record
User Update User Password Update password for a single user account record
User Reset Password Reset a user's password
User Delete User Delete a user account
User Delete User Session Deletes the user's current session. It is equivalent to logging out
View Get Agent Views Returns an array of agent views
Vsa Log List Agent Logs Returns an array of agent log entries for the specified log type
Vsa Log List Network Statistics Logs Returns an array of network statistics log entries for a given agent
Vsa Log List Monitor Action Logs Returns an array of monitor action log entries
Vsa Log List Legacy Remote Control Logs Returns an array of legacy remote control log entries
Vsa Log List Kaseya Remote Control Logs Returns an array of network statistics log entries
Vsa Log List Agent Procedure Logs Returns an array of agent procedure log entries