Create Alert Escalation Policy

Creates an alert escalation policy. The policy is a predefined action to be taken when an alert is not acknowledged.

Notes

  • escalationType:
    • AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETED: Automated notifications via recipient users until acknowledged, closed, suppressed, or ticketed.
    • AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED: Automated notifications via recipient users until acknowledged, closed, or suppressed.
    • MANUAL: Contact users directly as required.
  • filterCriteria: Use the following filter request structure for "Alert : Occurrence Frequency".
    • occurrences: Any integer.
    • frequency: Any integer.
    • frequencyType: In hours or days or weeks

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

Request Body

application/json

  • idstring

  • namestringrequired

  • descriptionstring

  • precedenceinteger

  • escalationTypestringrequired

    Automated notifications for recipient users

    Enum:
    AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETEDAUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSEDMANUALAUTOMATIC
  • policyTypestring

    Enum:
    ESCALATION_POLICY
  • createdDatestring

  • updatedDatestring

  • activeboolean

  • enabledModestring

    Enum:
    OFFONRECOMMENDOBSERVED

    Default: ON

  • resourcesarrayrequired

    Used to define different resources to apply the escalate alert policy.

  • escalationsarrayrequired

    Used to define the users for escalated alerts notifications.

  • filterCriteriaobject

  • allClientsboolean

  • updatedByobject

  • createdByobject

Loading Examples...

Responses

  • idstringrequired

    Escalation policy uuid

  • namestring

    Escalation policy name

  • descriptionstring

    Description details of escalation policy

  • precedenceinteger

    Precedence for alert escalation policy

  • policyTypestringrequired

    Policy type

    Enum:
    ESCALATION_POLICY
  • clientMatchingTypestring

    Included clients.Default value all i..e all the serviced clients.

  • updatedDatestring

    Last updated time

  • createdDatestring

    Last created time

  • activeboolean

    Is policy active

  • escalationTypestring

    Automated notifications types for recipient users

    Enum:
    AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETEDAUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSEDMANUALAUTOMATIC
  • allClientsboolean

    Include partner polices

  • resourcesarray

    Resource details

  • scopeobjectrequired

  • enabledModestring

    Enum:
    ONOFFRECOMMENDOBSERVED

    Default: ON

  • createdByobject

  • updatedByobject

  • filterCriteriaobject

  • escalationsarray

Loading Examples...