Hey! These docs are for version 6.5, which is no longer officially supported. Click here for the latest version, 6.7!

Acknowledge - Request Format

Acknowledge endpoint request details

URL: /rest/acknowledge. This requires authentication. Requires ACTIONSOME or ACTIONALL access.

  • GET - lists all hosts and services that can be acknowledged based on state and user permissions
  • POST - submit an acknowledgement
  • PUT - not implemented
  • DELETE - remove the acknowledgement as matched by the object selection

Access Control

  • ACTIONALL allows setting acknowledgements to any object in Opsview.
  • ACTIONSOME allows setting of acknowledgements to host or services based on the access object selection.

Note: If a user has ACTIONALL, but only VIEWSOME, the user could set acknowledgements for objects that they cannot view.

Object Selection

Acknowledgements are set against host or service objects.
You can choose hosts or services using the same URL parameters as the status API, with the following rules:

  • No parameters means that no objects are found (status API returns everything if no parameters is passed).
  • Service objects will be returned if you have added a filtering on a parameter which looks for services, otherwise host objects are returned.
  • No errors are raised if objects are not found.

Alternatively you can search for objects using the following parameters, based on the object type you are searching for:

  • hosts:

    • hst.hostid (same as hostid - this parameter takes priority)
    • hst.hostname
    • hst.hostgroupid (this is only for the host group that the host belongs too - this is not based on the host group hierarchy)
    • hst.hostgroupname (only for host's hostgroup, not the hierarchy)
  • services:

    • svc.serviceid (same as serviceid - this parameter takes priority)
    • svc.hs (same as hs)
    • svc.hostgroupid
    • svc.hostgroupname
    • svc.hostid
    • svc.hostname (can use % as wildcard)
    • svc.servicename (can use % as wildcard)
    • svc.keywordid
    • svc.keywordname
    • svc.servicegroupname
    • svc.servicecheckid

Note: host and services will only be found if you have the appropriate access to the object.
The basic rule is that if you are searching for multiple fields of the same type of object, then the search fields are AND'd together, but multiple values of the same field are OR'd together.
Duplicated host or services are ignored.

If you request a specific object (using hst.hostname, hst.hostid, svc.hs, svc.serviceid) and that object does not exist, an error is raised:

    message => "Error when searching for objects",
    detail => "Cannot find host with name nosuchhost; Cannot find host with id 3",

In no objects are found, an error is returned:

{ message => "No objects chosen for acknowledgements" }

For example, URL parameters of:


This would select the service hostA::service1, the service with id=45, and all services called HTTP or Disk:% on hostB or hostC.