Skip to main content
  • Navigate to Section...
    Introduction Platform Solutions Integrations Reference API
  • Getting Started
    • Getting started
    • Getting Started Examples
  • API User Guide
    • REST API Basics
    • Resource index and summary
  • Agents and Gateways
    • Assign agent resources policy
    • Assign agent resources profiles
    • Attach gateway to management profile
    • Configure gateway external proxy connection
    • Create management profile
    • Detach gateway from management profile
    • Download gateway files
    • Download Linux agent
    • Download Linux agent installation script
    • Download Windows agent
    • Generate gateway access token
    • Get gateway configuration details.** (New endpoint)
    • Get agent count by agent version
    • Get auth token to gateway. ** (New endpoint)
    • Get status, start and stop application services
    • Get the Linux agent
    • Gets gateway information
    • Gets gateway NGINX status and restart service
    • Gets gateway NTP details
    • Gets gateway timezone information
    • Manage management profile
    • Manually set gateway NTP date and time
    • Reconnect management profile tunnel
    • Register gateway
    • Restart network service
    • Search for management profile
    • Set gateway timezone
    • Set static route configuration
    • Specifies gateway network settings
    • Start and stop gateway NTP service
    • Synchronize NTP servers time
    • Turn Squid proxy service on and off
    • Update deployed gateway configurations. ** (New endpoint)
    • Update gateway NTP server IP addresses
  • Alerts
    • Acknowledge alert
    • Attach incident to alert
    • Create alert escalation policy
    • Create alert on a resource
    • Create alerts on resources
    • Create and get alert correlation policy
    • Create and get alert prediction policy
    • Create daily recurring schedule
    • Create partner and client rosters
    • Disable alert escalation policy
    • Enable alert escalation policy
    • Enable and disable first response policy
    • End scheduled maintenance window
    • Execute the required training type
    • Get alert comments
    • Get alert details
    • Get alert details by alert ID
    • Get alert details by event ID
    • Get alert details by incident ID
    • Get alert escalation policies
    • Get alert escalation policy
    • Get alert status history
    • Get alert view by view ID
    • Get alert views
    • Get alerts for alert-triggered time
    • Get organization rosters
    • Get resources of schedule maintenance windows
    • Get sub-alert types
    • Get supported alert types
    • Manage alert correlation policy
    • Manage alert correlation policy by ID
    • Manage alert escalation policy
    • Manage alert prediction policy by ID
    • Manage first response policy by ID
    • Manage first response policy details
    • Manage rosters
    • Manage schedule maintenance window resources
    • Manage scheduled maintenance windows
    • Post action on an alert
    • Resumes scheduled maintainence window
    • Search alerts
    • Search scheduled maintenance windows
    • Suspend scheduled maintenance window
    • Update incident with alert ID
  • Authentication
    • Get access token
  • Automation
    • Create a Process Workflow Automation
    • Create job
    • Delete RBA category
    • Get job types list
    • Get output logs
    • Get tenant jobs list
    • Manage jobs
    • Manage Process instances
    • Manage Process workflows
    • Manage RBA categories
    • Manage scripts
    • Manage scripts by ID
    • Process actions
    • Run a script
    • Run scheduled job
    • Search Process instances
    • Search process workflows
    • Signal external task
  • Exports
    • Create on-demand batch export template
  • Integrations
    • Activate integration event
    • Add a config profile details on the app.(** SDK Apps)
    • Create integration event
    • Deactivate integration event
    • Disable integration
    • Enable installed integration
    • Get all the config profiles details on the installed app. (** SDK apps)
    • Get and update discovery profiles
    • Get configurable email properties
    • Get installed integration events
    • Get integration activity
    • Get integration event placeholders
    • Get integration mappable properties
    • Install AWS integrations
    • Install Azure integration
    • Install custom integration.
    • Install email alert integration
    • Install email request integration
    • Install Google integration
    • Install integrations
    • Install Prometheus integration
    • Install SSO integration
    • Install VMWARE integration
    • Installs SDK based available apps.
    • Integrations monitoring template assignments.
    • Manage cloud discovery profile
    • Manage inbound authentication
    • Manage installed integration
    • Manage installed integration base notifier
    • Manage installed integration mapping attributes
    • Manage integration event
    • Managed config details of profile on the installed app. (** SDK Apps)
    • Rescan discovery profiles
    • Search available integrations / apps
    • Search cloud discovery profiles
    • Search installed integrations
    • Update the config profile details on the app.(** SDK apps)
  • Knowledge Base
    • Add comments to KB article
    • Create KB article
    • Create KB category
    • Create KB template
    • Delete KB articles
    • Delete KB category
    • Delete KB template
    • Download KB article attachment
    • Download KB article attachments
    • Get details of a given Category
    • Get KB article activity log
    • Get KB article template
    • Get KB category lists
    • Get KB sub-category lists
    • Get KB templates list
    • Get list of comments for KB article
    • Get list of KB articles
    • Manage KB article
    • Restore KB categories
    • Search KB articles
    • Share KB article
    • Update KB category
  • Metrics
    • Create metric types
    • Get metric (time series) on resources
    • Manage metric type
    • Manage resource metrics
  • Monitoring
    • Create resource monitors
    • Get assigned templates of resource
    • Get monitoring metric by ID
    • Get monitoring metric by Name
    • Manage resource templates
    • Search templates
  • Patching
    • Activate and deactivate patch baseline
    • Add and remove patches from baseline
    • Approve and disapprove patch
    • Approves and disapproves multiple patches on a given resource
    • Assign or unassign a baseline for patch compliance
    • Assign or unassign device group for patch compliance
    • Assign or unassign devices for patch compliance
    • Check resource patch compliance against baseline
    • Create and get patch baselines
    • Create compliance and get compliance checks
    • Create patch configuration and execute
    • Get and delete patch details
    • Get baseline details of compliance
    • Get device group details of a compliance
    • Get devices of a compliance
    • Get patch scan status of a device
    • Get patch scan status of all devices of a missing job
    • Get patches on a resource
    • Get patching status of a device
    • Get patching status of all devices in a patch configuration
    • Get resources against a baseline
    • Get resources against a baseline in a resourcegroup
    • Get, update, and delete patch baselines
    • Manage patch configuration
    • Run patch compliance check
    • Run patch configuration
    • Search patch configuration by client
    • Search patches
    • Update and delete patch compliance
  • Resource Management
    • Change WSUS settings
    • Create and update device groups
    • Create or update service group
    • Create resource note
    • Create site
    • Create tenant custom attribute type and values
    • Creates resource
    • Decommission a resource
    • Delete resource by resource type
    • Enable and disable client resource decommission
    • Get and delete device management policy
    • Get child resources and device groups
    • Get child resources and service groups
    • Get client custom attributes
    • Get console recording details of resources.
    • Get decommissioned resource data
    • Get device custom attributes of a device
    • Get latest antivirus definitions on resources
    • Get minimal details of device groups
    • Get minimal details of service groups
    • Get minimal resource details
    • Get minimal resource type details
    • Get minimal site details
    • Get private locations for synthetics
    • Get public locations for synthetics
    • Get resource applications
    • Get resource availability
    • Get root level device groups
    • Get root-level service groups
    • Get service availability
    • Get service group custom attributes
    • Get topology data by relationships
    • Get warranties
    • Link service group
    • Manage child resource for service group
    • Manage child resources for device groups
    • Manage client custom attributes
    • Manage custom attributes for devices
    • Manage custom attributes for service groups
    • Manage device groups
    • Manage device management policy
    • Manage device warranty
    • Manage resource availability rule
    • Manage resource dependency
    • Manage resources
    • Manage service group
    • Manage site
    • Manage tenant custom attributes
    • Manages remote consoles of the resource.
    • Manages resources for the Site.
    • Run device management policy
    • Search assigned entities by attribute
    • Search decommissioned resources
    • Search device management policy
    • Search resource notes
    • Search resources
    • Search sites
    • Search tenant custom attribute types and values
    • Unassign custom attributes for a resource
    • Unlink child service group
    • Update custom attribute value description
    • Update resource note
  • Tenancy and Access Controls
    • Activate or deactivate client
    • Activate user
    • Change password
    • Create and get credential set
    • Create and search user group
    • Create client
    • Create client notes
    • Create role
    • Create user
    • Get alert technologies
    • Get ARM cloud resources
    • Get AWS cloud resources
    • Get channels
    • Get countries
    • Get custom branding
    • Get Google cloud resources
    • Get minimal details of client credential sets
    • Get minimal details of clients
    • Get minimal details of device credential sets
    • Get minimal details of users
    • Get partner details
    • Get tenant NOCs
    • Get timezones
    • Get user login history
    • Manage client note
    • Manage credential set by ID
    • Manage role
    • Manage user groups
    • Manage users for user group
    • Search clients
    • Search for client notes
    • Search permission sets
    • Search roles
    • Search tenant users
    • Update and get client details
    • Update and get user details
  • Tickets
    • Add response to a problem
    • Add response to a service request
    • Add response to a time bound request
    • Add response to an incident
    • Add response to change request
    • Add response to task
    • Close change request
    • Close incident
    • Close problem
    • Close service request
    • Close task
    • Close time bound request
    • Create and get ticket notes
    • Create change request
    • Create change request categories
    • Create incident
    • Create incident categories
    • Create problem
    • Create problem categories
    • Create service request
    • Create service request categories
    • Create task
    • Create time bound request
    • Download change request response attachment
    • Download incident response attachment
    • Download problem response attachment
    • Download service request response attachment
    • Download task response attachment
    • Download time bound request response attachment
    • Get activity log of a change request
    • Get activity log of a problem
    • Get activity log of a service request
    • Get activity log of a task
    • Get activity log of a time bound request
    • Get activity log of an incident
    • Get change request custom form
    • Get change request responses
    • Get custom field
    • Get custom fields
    • Get incident custom form
    • Get incident responses
    • Get problem custom form
    • Get problem responses
    • Get service desk list of categories
    • Get service request custom form
    • Get service request responses
    • Get SLA policy
    • Get task responses
    • Get ticket status change reasons
    • Get time bound responses
    • Get time-bound request custom form
    • Manage change request
    • Manage forward mapping
    • Manage incident
    • Manage incident business impact
    • Manage incident urgency
    • Manage problem
    • Manage reverse mapping
    • Manage service request
    • Manage ticket notes by ID
    • Search change requests
    • Search incidents
    • Search problems
    • Search service requests
    • Search SLA policies
    • Search tasks
    • Search time bound requests
    • Update and get tasks
    • Update and get time bound request
    • Update change request category
    • Update incident business impact
    • Update incident category
    • Update problem category
    • Update service request category
    • Update urgency
    • Blog
    • Support
  2. API
  3. Agents and Gateways

Agents and Gateways

Endpoints associated with agents and gateways.

Leave Feedback

Copyright © 2021 OpsRamp, Inc. All rights reserved.

Leave us feedback

Error

Success

Your feedback has been sent!