Skip to main content

addSigCorrelationInfo

A Graze API POST request that associates the external client with a specified Situation. This allows Moogsoft Onprem to filter events and send only those of interest to an external system.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint addSigCorrelationInfo takes the following request arguments:

Name

Type

Required

Description

auth_token

String

Yes

A valid auth_token returned from the authenticate request. Alternatively, basic authenticate headers can be used in place of this parameter. See the authenticate endpoint for more information and usage examples.

sitn_id

Number

Yes

Situation ID.

service_name

String

Name of the external service, for example, ServiceNow.

resource_id

String

ID of the external service entity to associate with this Situation.

Response

Endpoint addSigCorrelationInfo returns the following response:

API update behavior

The behavior of this endpoint 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 endpoint updates the alert or Situation as follows:

See API Update Behavior for more information on Situation statuses.

Examples

The following examples demonstrate typical use of endpoint addSigCorrelationInfo:

Request example

Example cURL request to associate resource ID "my resource 7" in service "my service 7" with Situation ID 7:

curl -X POST -u graze:graze -k -v "https://localhost/graze/v1/addSigCorrelationInfo" -H "Content-Type: application/json; charset=UTF-8" -d '{"sitn_id" : 3, "service_name" : "my service 7", "resource_id" : "my resource 7"}'

Response example

In this section: