Manage Alert Escalation Policy

Gets, update and delete alert escalation policy of tenant by policyId.

delete
/api/v2/tenants/{tenantId}/escalations/{policyId}

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

  • policyIdstringrequired

    Policy unique identifier

get
/api/v2/tenants/{tenantId}/escalations/{policyId}

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

  • policyIdstringrequired

    Policy unique identifier

Query Parameters

  • scopestring

    Users, User Groups, and Rosters to receive the escalations.

  • rostersstring

    Roster is a list of users part of the schedule doing particular duty.

  • escalationTypestring

    Escalation rules are actions taken when an alert is not acknowledged within the desired time.OpsRamp supports manual and automatic escalation types.

    Enum:
    MANUALAUTOMATIC
  • actionstring

    Escalation action to take - Escalate as Notification implies to send periodic notifications to users until the alert is acknowledged. - Escalate as Incident implies to automatically create an incident from the alert and assign to the desired user/team.

    Enum:
    NOTIFICATIONINCIDENT
  • escalationsstring

    Information about the escalation actions.

  • waitMinsstring

    The time interval to escalate an alert after generation. Escalate after the alert has elapsed the set time.

  • notifyLimitCountstring

    A threshold limit on the number of notifications a user receives. Example: notifyLimitCount: 5

  • alertStateTransitionFromstring

    For every change in the alert state, user receives notifications.

  • recipientsstring

    - For escalationType: MANUAL- Users to contact directly. User ID (or) name. - For escalationType: AUTOMATIC- Recipients who receives notifications.

  • allClientsstring

    This string helps to differentiate between partner and client escalation policies. allClients: true indicates the policy is a partner level policy.

  • machineLearningstring

    This string indicates that machine-learning is enabled to automatically escalate an incident to appropriate teams. - Machine-learning enabled incident attributes: Example: Assignee Group, Priority - "Assignee Group" is the Incident attribute and "incident.assigneeGroup" is the respective output column in a CSV file. - learnedFieldsToOutputColumnsMap"Assignee Group": "incident.assigneeGroup","Priority": "incident.priority"

  • repeatFrequencystring

    The time interval when a user receives repeated notifications. This example indicates that a user receives repeated notifications every 15 minutes: repeatFrequency: 15.

00
post
/api/v2/tenants/{tenantId}/escalations/{policyId}

When the escalation action is set to INCIDENT, an incident is automatically created from the alert and assigned to the desired user/team.

  • Create New Incident
  • Update Incident

No further level of escalation can be added as the escalation ends when an incident is created from the alert.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

  • policyIdstringrequired

    Policy unique identifier

00
00