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

Rest API Config endpoint for hashtags (previously known as keywords)

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

Parameters:

  • calculate_hard_states - if set, the hashtag summary status will be based on the hard states of the services, not the current state. Note, it will be possible that the hashtag will have a calculated state of OK but in an unhandled state

Example GET:

{
   "object" : {
      "all_hosts" : "0",
      "hosts" : [
         {
            "ref" : "/rest/config/host/7",
            "name" : "cisco"
         },
         {
            "ref" : "/rest/config/host/8",
            "name" : "cisco1"
         }
      ],
      "roles" : [
         {
            "ref" : "/rest/config/role/14",
            "name" : "View some, change none"
         },
         {
            "ref" : "/rest/config/role/15",
            "name" : "View some, change none, no notify"
         }
      ],
      "all_servicechecks" : "0",
      "style" : "group_by_host",
      "name" : "cisco",
      "description" : "cisco devices",
      "servicechecks" : [
         {
            "ref" : "/rest/config/servicecheck/82",
            "name" : "Another exception"
         },
         {
            "ref" : "/rest/config/servicecheck/81",
            "name" : "Test exceptions"
         }
      ],
      "id" : "2",
      "enabled" : "1",
      "uncommitted" : "1"
   }
}