Manage Alert Escalation Policy
Gets, update and delete alert escalation policy of tenant by policyId.
Path Parameters
- tenantId
Describes the clientId or mspId of the tenant
- policyId
Policy unique identifier
Query Parameters
- scope
Users, User Groups, and Rosters to receive the escalations.
- rosters
Roster is a list of users part of the schedule doing particular duty.
- escalationType
Escalation rules are actions taken when an alert is not acknowledged within the desired time.OpsRamp supports manual and automatic escalation types.
- Enum:
- MANUALAUTOMATIC
- action
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
- escalations
Information about the escalation actions.
- waitMins
The time interval to escalate an alert after generation. Escalate after the alert has elapsed the set time.
- notifyLimitCount
A threshold limit on the number of notifications a user receives. Example: notifyLimitCount: 5
- alertStateTransitionFrom
For every change in the alert state, user receives notifications.
- recipients
- For escalationType: MANUAL- Users to contact directly. User ID (or) name. - For escalationType: AUTOMATIC- Recipients who receives notifications.
- allClients
This string helps to differentiate between partner and client escalation policies. allClients: true indicates the policy is a partner level policy.
- machineLearning
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"
- repeatFrequency
The time interval when a user receives repeated notifications. This example indicates that a user receives repeated notifications every 15 minutes: repeatFrequency: 15.
Responses
- id
Escalation policy uuid
- name
Escalation policy name
- description
Description details of escalation policy
- policyType
Policy type
- Enum:
- ESCALATION_POLICY
- clientMatchingType
Included clients.Default value all i..e all the serviced clients.
- updatedDate
Last updated time
- createdDate
Last created time
- active
Is policy active
- escalationType
Automated notifications types for recipient users
- Enum:
- AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETEDAUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSEDMANUALAUTOMATIC
- allClients
Include partner polices
- resources
Resource details
- scope
- enabledMode
- Enum:
- ONOFFRECOMMENDOBSERVED
Default: ON
- createdBy
- updatedBy
- filterCriteria
- escalations
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
- tenantId
Describes the clientId or mspId of the tenant
- policyId
Policy unique identifier
Request Body
application/json
- id
- name
- description
- escalationType
Automated notifications for recipient users
- Enum:
- AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETEDAUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSEDMANUALAUTOMATIC
- policyType
- Enum:
- ESCALATION_POLICY
- createdDate
- updatedDate
- active
- enabledMode
- Enum:
- OFFONRECOMMENDOBSERVED
Default: ON
- resources
Used to define different resources to apply the escalate alert policy.
- escalations
Used to define the users for escalated alerts notifications.
- filterCriteria
- allClients
- updatedBy
- createdBy
Responses
- id
Escalation policy uuid
- name
Escalation policy name
- description
Description details of escalation policy
- policyType
Policy type
- Enum:
- ESCALATION_POLICY
- clientMatchingType
Included clients.Default value all i..e all the serviced clients.
- updatedDate
Last updated time
- createdDate
Last created time
- active
Is policy active
- escalationType
Automated notifications types for recipient users
- Enum:
- AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETEDAUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSEDMANUALAUTOMATIC
- allClients
Include partner polices
- resources
Resource details
- scope
- enabledMode
- Enum:
- ONOFFRECOMMENDOBSERVED
Default: ON
- createdBy
- updatedBy
- filterCriteria
- escalations
Path Parameters
- tenantId
Describes the clientId or mspId of the tenant
- policyId
Policy unique identifier