Config - Hashtag/Keyword

Object type: keyword

Note

Even though they are called hashtags in the UI and documentation, they are still referenced as keywords in the REST API.

Request URL: /rest/config/keyword

Permissions: Requires CONFIGUREKEYWORDS

Methods:

• GET — List hashtags.
• POST — Create hashtag.
• PUT — Update hashtag.
• DELETE — Unimplemented.

Example GET Copied

Fields:

• id - ID number for this hashtag.
• name - name of the hashtag.
• all_hosts - if set, then all hosts with the specified service checks will be included in the bulk tagging selection.
• all_servicechecks - if set, then all service checks on the specified hosts will be included in the bulk tagging selection.
• calculate_hard_states — if set, the hashtag summary status will be based on the hard states of the services, not the current state. It is possible that the hashtag will have a calculated state of OK but in an unhandled state.
• description - text to display in the hashtag detail view.
• enabled - if set, this hashtag will be included in the Hashtags Summary view.
• exclude_handled - if set, Opsview will exclude handled services from the calculation of the overall hashtag status. For example, with this setting enabled, a service in a handled CRITICAL state will be ignored. If this setting is disabled, the hashtag state will become CRITICAL.
• hosts - list of hosts specified in this hashtag for bulk tagging.
• individual_objects - returns an array of individually selected objects that will be associated with this hashtag. This column is not retrieved in a GET by default - add cols=+individual_objects in a GET request to include this column (with the + symbol URL encoded if required). The fields within each individual object:
  • id - unique ID for this individual object in this table.
  • host_id - ID of the host from the configuration database.
  • host_name - current host name for that host_id (from the configuration database, before an Apply Changes).
  • servicecheck_id - ID of the service check from the configuration database.
  • servicecheck_name - current name of the service check (from the configuration database, before an Apply Changes).
  • attribute_value - if the service check is a multi-servicecheck, this is the host variable value for that host service. Note that this value might not yet exist in the database or at runtime. It can be NULL, but it cannot be an empty string.
• public - if set, this hashtag is visible to users in the Hashtags Summary View even if their permission does not include this hashtag.
• roles - list of roles that have permission to see this hashtag.
• servicechecks - list of service checks specified in this hashtag for bulk tagging.
• show_contextual_menus - deprecated.
• style - deprecated.
• uncommitted - if set, you need to run Apply Changes to make any changes live.

Example POST/PUT Copied

individual_objects Copied

The input for this field is expected to be an array of objects. The logic for creating is:

• For each individual object:
  • If an ID is specified and already exists for this hashtag, all other fields are assumed to have the same values as those in the database, and the rest of the object is ignored.
  • If an ID is not specified, or is 0, it is considered a new individual object. The system searches for host_id and servicecheck_id in the current configuration database based on the input host_name and servicecheck_name. If either is not found, then the individual object is ignored. This means there is a potential race condition if a host name is changed while editing this object or if a host has been renamed in the configuration database but Apply Changes has not been run yet.
  • If an attribute_value is specified and it is either null or an empty string, it will be saved as null.
• Any objects currently associated with this hashtag that are not listed in this call will be removed.