Moogsoft Docs

getSituationHosts

A MoogDb v2 method that returns a list of host names for a Situation, either for all alerts in the Situation or just for unique alerts.

Back to MoogDb V2 API Method Reference.

Request arguments

Method getSituationHosts takes the following request arguments:

Name

Type

Required

Description

situationId

Number

Yes

Situation ID.

uniqueOnly

Boolean

No

Response

Method getSituationHosts returns the following response:

Type

Description

Native Object

A JSON array containing the host names.

API behavior in active and historic databases

The behavior of this method depends on whether the relevant alert or Situation is open, closed and still in the active database, or closed and archived to the historic database. This method updates or returns information about the alert or Situation as follows:

See API Update Behavior for more information on Situation statuses.

Examples

The following examples demonstrate typical use of method getSituationHosts:

Response example

Example response returning the host names for the Situation:

{ 
    "hosts": [
        "server1",
        "server2",
        "server3",
        "server4",
        "server5",
        "server6",
        "server7"
    ]
}