OpsGenie · Schema

CreateEscalationRequest

AlertsIncident ManagementMonitoringOn-CallOperations

Properties

Name Type Description
name string Name of the escalation policy.
description string Description of the escalation policy.
ownerTeam object Team that owns the escalation.
rules array Escalation rules defining the notification sequence.
repeat object Repeat configuration for the escalation.
View JSON Schema on GitHub

JSON Schema

opsgenie-createescalationrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateEscalationRequest",
  "title": "CreateEscalationRequest",
  "type": "object",
  "required": [
    "name",
    "rules"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the escalation policy."
    },
    "description": {
      "type": "string",
      "description": "Description of the escalation policy."
    },
    "ownerTeam": {
      "type": "object",
      "description": "Team that owns the escalation.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Team ID."
        },
        "name": {
          "type": "string",
          "description": "Team name."
        }
      }
    },
    "rules": {
      "type": "array",
      "description": "Escalation rules defining the notification sequence.",
      "items": {
        "$ref": "#/components/schemas/EscalationRule"
      }
    },
    "repeat": {
      "type": "object",
      "description": "Repeat configuration for the escalation.",
      "properties": {
        "waitInterval": {
          "type": "integer",
          "description": "Wait interval in minutes before repeating."
        },
        "count": {
          "type": "integer",
          "description": "Number of times to repeat."
        },
        "resetRecipientStates": {
          "type": "boolean",
          "description": "Whether to reset recipient notification states on repeat."
        },
        "closeAlertAfterAll": {
          "type": "boolean",
          "description": "Whether to close the alert after all repeats."
        }
      }
    }
  }
}