Acknowledge - Request Format

URL: /rest/acknowledge. This requires authentication.

Requires ACTIONSOME or ACTIONALL access.

Access Control Copied


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

Object Selection Copied

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:

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


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.

["Opsview"] ["API", "Technical Reference"]

Was this topic helpful?