Docs
Support
Open Documentation Search
Search
/
Open main menu
Home
OpsQL
Select API Version
v2
Getting Started
API Overview
Agents
Download Linux Agent
Get Agent Package Details
Download Linux Agent Installation Script
Download Windows Agent
Agent Auto-Updates
Assign Agent Resources Policy
Assign Master Agent profile to Resources
Alerts
Create Alerts on Resources
Create Alert on a Resource
Get Alert Details
Get Alert Details by Event ID
Search Alerts
Post Action on an Alert
Associate Incident to Alert
Update incident with alert ID
List the Alerts Occurences triggered
Get Alert Status History
Get Alert Comments
Get Alert Escalation Policy associated with alert
Get Alert Views
Get Alert View by View ID
Create Rosters
Manage Rosters
Search Rosters
Create Alert Escalation Policy
Manage Alert Escalation Policy
Set Alert Escalation Policy mode
Search Escalation Policies
Manage Alert Correlation Policy
Manage Alert Correlation
Set Alert Correlation Policy mode
Create and Get Alert Prediction Policy
Manage Alert Prediction Policy
Manage First Response Policy Details
Manage First Response Policy by ID
Enable and Disable First Response Policy
Post the Request for Required Machine Learning Training Type
Create Schedule Maintainence Activity
Manage Scheduled Maintenance Windows
Get Resources of Schedule Maintenance Windows
End Scheduled Maintenance Window
Resumes Scheduled Maintainence Window
Suspend scheduled maintenance window
Search Scheduled Maintenance Windows
Manage Schedule Maintenance Window Resources
Get Supported Alert Types
Get Sub-Alert Types
Get Alert Details by Incident ID
Authentication
Get Access Token
Automation
Create Job
Manage Jobs
Get Tenant Jobs List
Get Job Types
Run Scheduled Job
Run a Script
Manage RBA Categories
Delete RBA Category
Manage Scripts
Manage Scripts by ID
Get Output Logs
Create a Process Workflow Automation
Manage Process Workflows
Search Process Workflows
Manage Process Instances
Search Process Instances
Process Actions
Signal External Task
Exports
Batch Exports
Manage Batch Export
Alert Streaming Configuration
Manage Alert Streaming Configuration
Gateways
Get Auth Token to Gateway
Get Gateway Configuration Details
Update Gateway Configurations
Integrations
Search Available Integrations/Apps
Install Integrations
Install Custom Integration
Install Email Alert Integration
Install Email Request Integration
Install SSO Integration
Install Prometheus Integration
Search Installed Integrations
Manage Installed Integration
Integration Actions
Manage Inbound Authentication
Get Configurable Email Properties
Get Integration Mappable Properties
Manage Installed Integration Mapping Attributes
Get Integration Event Placeholders
Manage Installed Integration Base Notifier
Get Installed Integration Events
Create Integration Event
Enable Disable Integration Event
Re-process Failed Integration Events
Manage Integration Event
Integrations Monitoring Template Assignments
Search Cloud Discovery Profiles
Get and Update Discovery Profiles
Manage Cloud Discovery Profile
Rescan Discovery Profiles
Get Integration Activity
Installs Sdk Based Available Apps
Get Config Details on Installed App
Add a Config Profile Details on the App
Managed Config Details of Profile on the Installed app
Update the config profile details on the app
List cluster nodes
Knowledge Base
Get KB Category Lists
Create KB Category
Get Details of a Given Category
Get KB Sub-Category Lists
Update KB Category
Delete KB Category
Restore KB Categories
Get List of KB Articles
Search KB Articles
Create KB Article
Manage KB Article
Delete KB Articles
Add Comments to KB Article
Get List of Comments for KB Article
Share KB Article
Get KB Article Activity Log
Download KB Article Attachment
Download KB Article Attachments
Get KB Templates List
Create KB Template
Get KB Article Template
Delete KB Template
Management Profiles
Download Gateway Files
Create Management Profile
Manage Management Profile
Attach Gateway to Management Profile
Detach Gateway From Management Profile
Reconnect Management Profile Tunnel
Search for Management Profile
Metrics
Metrics
Manage a Metric
Post Time-Series Metric Data
Time-Series Metric Data
Monitoring
Search Templates
Manage Assigned Templates
Get Assigned Templates
Create Resource Monitors
Syslog Rules
Manage Syslog Rules
Syslog Profiles
Manage Syslog Profiles
Export Syslog Profiles
Import Syslog Profiles
Patching
Create and Get Patch Baselines
Activate and Deactivate Patch Baseline
Add and Remove Patches From Baseline
Get, Update, and Delete Patch Baselines
Assign or Unassign a Baseline for Patch Compliance
Assign or Unassign Device Group for Patch Compliance
Assign or Unassign Devices for Patch Compliance
Get Baseline Details of Compliance
Create Compliance and Get Compliance Checks
Update and Delete Patch Compliance
Get Devices of a Compliance
Get Device Group Details of a Compliance
Run Patch Compliance Check
Create Patch Configuration and Execute
Manage Patch Configuration
Run Patch Configuration
Search Patch Configuration by Client
Manage Patch Qualifications.
Search Patches
Get Patch Scan Status of All Devices of a Missing Job
Get Patching Status of All Devices in a Patch Configuration
Approve and Disapprove Patch
Get Patch Scan Status of a Device
Get Patching Status of a Device
Check Resource Patch Compliance Against Baseline
Get Patches on a Resource
Get Resources Against a Baseline
Get Resources Against a Baseline in a Resourcegroup
Approves and Disapproves Multiple Patches on a Given Resource
Resource Management
Creates Resource
Manage Resources
Get Minimal Resource Details
Search Resources
Get Latest Antivirus Definitions on Resources
Create Resource Note
Update Resource Note
Search Resource Notes
Manage Device Warranty
Decommission a Resource
Get Resource Availability
Manage Resource Availability Rule
Get Resource Applications
Get Last Discovered Services.
Get Console Recording Details of Resources
Manages Remote Consoles of the Resource
Perform Resource Management Actions
Search Decommissioned Resources
Get Decommissioned Resource Data
Change WSUS Settings
Create and update device groups
Manage Device Groups
Get Minimal Details of Device Groups
Get Root Level Device Groups
Manage Child Resources for Device Groups
Get Child Resources and Device Groups
Search Device Management Policy
Manage Device Management Policy
Get and Delete Device Management Policy
Run Device Management Policy
Create or Update Service Group
Manage Service Group
Link Service Group
Manage Child Resource for Service Group
Unlink Child Service Group
Get Child Resources and Service Groups
Get Root-Level Service Groups
Get Minimal Details of Service Groups
Create Site
Manage Site
Manages resources for the Site
Search Sites
Get Minimal Site Details
Get Warranties
Get Service Availability
Enable and Disable Client Resource Decommission
Get Minimal Resource Type Details
Get Public Locations for Synthetics
Get Private Locations for Synthetics
Tenancy Access Controls
Create Client
Update and Get Client Details
Get Minimal Details of Clients
Search Clients
Manage Tenant Custom Branding
Terminate Client
Permission Sets
Manage Permission Sets
Create Role
Manage Role
Search Roles
Create User
Update and Get User Details
Get Minimal Details of Users
Search Tenant Users
Manage User
Change Password
Create and Search User Group
Manage User Groups
Manage User for User Group
Get User Login History
Create and Get Credential Set
Manage Credential Set by ID
Get Minimal Details of Client Credential Sets
Get Minimal Details of Device Credential Sets
Create Client Notes
Manage Client Note
Search for Client Notes
Get Countries
Get Tenant NOCs
Get Timezones
Get Partner Details
Get Channels
Get Alert Technologies
Get ARM Cloud Resources
Get AWS Cloud Resources
Get Google Cloud Resources
Tickets
Create Tickets
Manage Tickets
Search Tickets
Create Ticket Categories
Update and Get Categories List
Manage Incident Business Impact
Update Incident Business Impact
Manage Forward Mapping
Manage Reverse mapping
Manage Incident Urgency
Update Incident Urgency
Update Tickets with Actions
Get Ticket Status Change Reasons
Post a Response on Ticket
Search Ticket Responses
Get Ticket Responses for a Resource
Create and Get Ticket Notes
Manage Ticket Notes
Get Custom Form Details
Custom Fields
Manage Custom Fields
Get Ticket Custom Fields
Get SLA Policy
Search SLA Policies
Get Activity Log of tickets
OpsQL
Download OAS
queries
/opsql/api/v3/tenants/
{tenantId}
/queries
post