Manage Alert Correlation Policy

Creates and gets alert correlation policies for tenants.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

Query Parameters

  • pageNointeger

    Default: 1

  • pageSizeinteger

    Default: 100

Responses

  • resultsarray

  • totalResultsinteger

  • orderBystring

  • pageNointeger

  • pageSizeinteger

  • totalPagesinteger

  • nextPageboolean

  • previousPageNointeger

  • descendingOrderboolean

Loading Examples...

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

Request Body

application/json

  • namestringrequired

    The name of the alert correlation policy.

  • filterCriteriaobject

    Filter for resources whose alerts will match this policy.

  • typestring

    The alert correlation policy type.

    Enum:
    DEPENDENCYALGORITHMCO_OCCURRENCE
  • dependencyCorrelationobject

    Correlate alerts on upstream and downstream resources.

  • algorithmCorrelationobject

    Correlate alerts that share similar alert properties.

  • organizationMatchingTypestring

  • includedClientsarray of strings

  • enabledModestring

    To enable an alert correlation policy, set "enabledMode": "ON". To disable an alert correlation policy, set "enabledMode: "OFF". To enable an alert correlation policy to observe, set "enabledMode": "OBSERVED".

    Enum:
    ONOFFOBSERVED
  • precedenceinteger

    Determine the execution order of a policy. For example, if VMware is specified as part of the agent status policy and network outage policy, the user can determine which policy should execute first to correlate VMware alerts.

Loading Examples...

Responses

  • idstring

  • namestring

  • enabledboolean

  • precedenceinteger

  • filterCriteriaobject

  • typestring

  • algorithmCorrelationobject

  • createdByobject

  • createdTimestring

  • updatedTimestring

Loading Examples...