VIPRE Endpoint API

Written By Marissa Fegan (Super Administrator)

Updated at December 18th, 2024

The following information regarding the VIPRE Cloud API can be found within your Endpoint product web console. Navigate to the Help tab, select Documentation, and then click Download under API Documentation. 

Devices API

This API section typically manages endpoint interactions and visibility. It allows various operations related specifically to the devices running in your environment.

Common Use Cases:

  • Inventory Management: Retrieve a comprehensive list of devices connected to the network.
  • Security Status Checks: Monitor and update the health status of devices.
  • Action Execution: Implement commands to isolate a device, tag it, or trigger scans for threats.

Events API

APIs related to events within Device Control and allows the retrieval list of device control events that occur on a site or across all MSP sites.

Common Use Cases:

  • Device Control Event Querying: Search through logs for events associated with specific devices.
  • Behavioral Analysis: Track patterns that could indicate anomalies or threats.
  • Audit Trails: Maintain compliance by accessing detailed records of past incidents.

Site API

This API allows you to retrieve key information about sites within Site Manager or to create child Sites .

Common Use Cases:

  • Retrieval of site information: View data about different Sites.
  • Create Child Sites: using API key from a Site Manager, sites can be created using different attributes to denote if they are a Trial, Production etc…

Threats API

This section focuses on retrieves the list of threats that occur on a site or across all MSP sites.

Common Use Cases:

  • Threat Intelligence Access: Review comprehensive information about identified threats.
  • Integrations: Share threat data with other security systems for unified monitoring.

Incidents API

Incidents APIs contains various Get & Post commands that allow you to retrieve information about incidents or update/amend those incidents.

Common Use Cases:

  • Incident Tracking: View and update incident statuses (open, in-progress, or closed).
  • Collaborative Response: Integrate with team management tools for collaborative resolution efforts.
  • Automation: Trigger automated workflows when certain incident criteria are met.