Skip to main content
Alerting & Response/Alert Rules

CreateAlertInhibitionRule

Create a new inhibition rule for correlating and suppressing alerts

POST/api/v1/alerting/inhibition-rules

Operation ID

CreateAlertInhibitionRule

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • name
    String

    Human-readable rule name

    Example: Suppress disk alerts when host down

  • description
    String

    Rule description

    Example: Suppress disk alerts when host is unreachable

  • sourceMatchers
    List

    Source matchers for this resource

    Example: (nested array)

    • key
      String

      Whitelisted alert label key to match

      Example: severity

    • operator
      String

      Match operator: eq, neq, or regex

      Example: eq

    • value
      String

      Value used by the selected operator

      Example: critical

  • targetMatchers
    List

    Target matchers for this resource

    Example: (nested array)

    • key
      String

      Whitelisted alert label key to match

      Example: severity

    • operator
      String

      Match operator: eq, neq, or regex

      Example: eq

    • value
      String

      Value used by the selected operator

      Example: critical

  • equalLabelNames
    List

    Equal label names for this resource

    Example: item1,item2

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • uuid
    String

    Unique identifier of the inhibition rule

    Example: inhib-001

  • name
    String

    Human-readable rule name

    Example: Suppress disk alerts when host down

  • description
    String

    Rule description

    Example: Suppress disk alerts when host is unreachable

  • enabled
    Boolean

    Whether this inhibition rule is active

    Example: true

  • createDate
    String

    Timestamp when the rule was created

    Example: 2026-01-15T08:00:00Z

  • lastOpDate
    String

    Timestamp of the last modification

    Example: 2026-01-15T08:00:00Z

  • sourceMatchers
    List

    Source matchers for this resource

    Example: (nested array)

    • key
      String

      Whitelisted alert label key to match

      Example: severity

    • operator
      String

      Match operator: eq, neq, or regex

      Example: eq

    • value
      String

      Value used by the selected operator

      Example: critical

  • targetMatchers
    List

    Target matchers for this resource

    Example: (nested array)

    • key
      String

      Whitelisted alert label key to match

      Example: severity

    • operator
      String

      Match operator: eq, neq, or regex

      Example: eq

    • value
      String

      Value used by the selected operator

      Example: critical

  • equalLabelNames
    List

    Equal label names for this resource

    Example: item1,item2

  • reason
    String

    Reason for this resource

    Example: value

  • createdBy
    String

    Created by for this resource

    Example: value

  • lastModifiedBy
    String

    Last modified by for this resource

    Example: value

  • version
    String

    Version for this resource

    Example: 10

  • currentHitCount
    String

    Distinct active target alert owners currently matched by this inhibition rule

    Example: 3

  • sourceMatchersDisplay
    List

    Read-only matcher display in Content-Language; preserves original order and duplicate conditions

    Example: (nested array)

    • key
      String

      Original alert label key from the matcher, such as rule_uuid or resource_type, preserved unchanged alongside its localized display name.

      Example: value

    • operator
      String

      Operator for this resource

      Example: value

    • value
      String

      Value for this resource

      Example: value

    • displayName
      String

      Display name for this resource

      Example: value

    • valueDisplayName
      String

      Empty when unresolved or inaccessible; regex/nregex preserve the expression.

      Example: value

  • targetMatchersDisplay
    List

    Read-only matcher display in Content-Language; preserves original order and duplicate conditions

    Example: (nested array)

    • key
      String

      Original alert label key from the matcher, such as rule_uuid or resource_type, preserved unchanged alongside its localized display name.

      Example: value

    • operator
      String

      Operator for this resource

      Example: value

    • value
      String

      Value for this resource

      Example: value

    • displayName
      String

      Display name for this resource

      Example: value

    • valueDisplayName
      String

      Empty when unresolved or inaccessible; regex/nregex preserve the expression.

      Example: value

  • Change Time

    AddedRequest body fields enabled
    View API
  • Change Time

    AddedRequest body fields equalLabelNames, key, operator...DeletedRequest body fields equalLabels, sourceMatch, targetMatchAddedResponse fields createdBy, currentHitCount, displayName...DeletedResponse fields equalLabels, sourceMatch, targetMatch
    View API