Notes - Request Format

Details about the Notes endpoint

URL: /rest/notes/OBJECTTYPE/ID.

Requires authentication.

The object types are:

  • Host (host). Can also use /rest/notes/host?hostname=X
  • Service (service). Can also use /rest/notes/service?hostname=X&servicename=Y
  • Host Group (hostgroup). Can also use /rest/notes/hostgroup?hostgroupid=X
  • Business service (bsmservice)
  • Component (bsmcomponent)

Access Control

Access control is based on the object types:

  • host - requires VIEWALL or VIEWSOME with this object to view. Requires ACTIONSOME to edit. ID is based on the opsview host id.
  • service - requires VIEWALL or VIEWSOME for this object to view. Requires ACTIONSOME to edit. ID is based on the nagios_object_id number
  • bsmservice - requires view access based on BSM permissions to view. Requires edit access to edit.
  • bsmcomponent - requires view access based on BSM permissions to view. Requires edit access to edit.