Skip to main content

/situations/{situationID}/topologies

The /situations/{situationID}/topologies endpoint allows you to retrieve the topologies related to the alerts in a specified Situation.

To retrieve the node and link details for a specified Situation and topology see getSituationTopology.

Back to Topologies API Endpoint Reference.

GET

Retrieves the topologies related to a specified Situation.

Path parameters

The GET request takes the following path parameter:

Name

Type

Required

Description

 sitn_id

Number

Yes

ID of the Situation for which to retrieve topologies.

Response

The GET request returns the following response:

Successful requests return an array of JSON objects containing the following:

Name

Type

Description

name

String

Name of the topology.

causal

Boolean

Flag indicating whether this topology caused the Situation to be created.

Example

The following example demonstrates making a GET request to the situations/{situationID}/topologies endpoint.

Request example

Example cURL request for topologies related to the alerts in Situation with ID 12:

curl \
https://example.com/api/v1/situations/12/topologies \
-u phil:password123 \

Response example

Example response returning the details of two topologies:

[
    { 
        “name” : “host”, 
        “causal”: true 
    }, 
    { 
        “name” : “location”, 
        “causal” : false 
    }
]
In this section: