Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. Monitoring
    1. Get started with monitoring
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  4. On-call scheduling and alerting
    1. Get started with on-call
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced on-call setup
  5. Incidents
    1. Working with incidents
    2. Create incidents manually
    3. Post mortems
    4. Incident silencing
    5. Incident metadata
  6. Status pages
    1. Get started with status pages
    2. Working with status pages
  7. Integrations
    1. Integrating with Better Stack
  8. Team and account management
    1. Team management
    2. Account settings
    3. Audit logs
    4. Migrating to pay as you go
  9. API
    1. Get started with API
  10. Monitors API
    1. Monitors
    2. Monitor groups
    3. Heartbeats
    4. Heartbeat groups
  11. On-call & Incidents API
    1. On-call calendar
    2. On-call calendar events
    3. Escalation policies
      1. List all escalation policies GET
      2. Get a single escalation policy GET
      3. Create an escalation policy POST
      4. Update an escalation policy PATCH
      5. Delete an escalation policy DELETE
      6. Escalation policies API response params
    4. Escalation policy groups
    5. Severities
    6. Severity groups
    7. Incidents
    8. Comments
  12. Integrations API
    1. New Relic Integrations
    2. Datadog Integrations
    3. AWS CloudWatch Integrations
    4. Azure Integrations
    5. Google Monitoring Integrations
    6. Grafana Integrations
    7. Prometheus Integrations
    8. Email integrations
    9. Incoming webhooks
    10. Slack Integrations
    11. Outgoing Webhook integrations
    12. Splunk On-Call integrations
    13. PagerDuty Integrations
  13. Status pages API
    1. Status pages
    2. Status page sections
    3. Status page resources
    4. Status page reports
    5. Status page report updates
  14. Other API
    1. Metadata

Escalation policies API response params

Response body parameters

Namespace data

Parameter Type Values
id String ID of the escalation policy.
type String policy
attributes Object Attributes object. See below.
attributes.name String Name of the policy.
attributes.repeat_count Integer How many times should the entire policy be repeated if no one acknowledges the incident.
attributes.repeat_delay Integer How long in seconds to wait before each repetition.
attributes.incident_token String Incident token that can be used for manually reporting incidents.
attributes.policy_group_id Integer The policy group this policy is in. Set this attribute to assign this policy to a policy group.
attributes.team_name String The name of the team this policy is in.
attributes.steps.[] PolicyStep An array of escalation policy steps. See the PolicyStep section below for attribute details.

PolicyStep

Parameter Type Values
type String The type of the step. Can be either escalation, time_branching, or metadata_branching.
wait_before Integer How long to wait in seconds before executing this step since previous step. Omit if wait_until_time is set.
wait_until_time String (HH:MM) Execute this step at the specified time. Omit if wait_before is set.
wait_until_timezone String Timezone to use when interpreting wait_until_time. Omit if wait_before is set.
urgency_id Integer Which severity to use for this step. Used when step type is escalation.
step_members.[] PolicyStepMember An array of escalation policy steps members. Used when step type is escalation. See the PolicyStepMember section below for attribute details.
timezone String What timezone to use when evaluating time based branching rules. Used when step type is time_branching. The accepted values can be found in the Rails TimeZone documentation.
days String[] An array of days during which the branching rule will be executed. Valid values are ["mon", "tue", "wed", "thu", "fri", "sat", "sun"]. Used when step type is time_branching.
time_from String A time from which the branching rule will be executed. Use HH:MM format. Used when step type is time_branching.
time_to String A time at which the branching rule will step being executed. Use HH:MM format. Used when step type is time_branching.
metadata_key String A metadata field key to check. Used when step type is metadata_branching.
metadata_values String[] An array of metadata values which will cause the branching rule to be executed. Used when step type is metadata_branching.
policy_id Integer A policy to executed if the branching rule matches the time of an incident. Policy is only stopped when null is provided. Used when step type is time_branching or metadata_branching.

PolicyStepMember

Parameter Type Values
type String Type type of the member to notify during an incident. Can be one of current_on_call, entire_team, all_slack_integrations, all_microsoft_teams_integrations, all_zapier_integrations, all_webhook_integrations, all_splunk_on_call_integrations, user, webhook, slack_integration, microsoft_teams_integration, zapier_webhook.
id String The ID of the resource to notify during an incident. Required for webhook, slack_integration, microsoft_teams_integration and zapier_webhook member types. This is e.g. the ID of the user to notify when type is user, or optionally ID of the team when type is current_on_call.
email String The e-mail of the user to notify. Used when type is user. When email is provided the id will be inferred automatically.

Previous article

Delete an escalation policy

Next article

List all existing escalation policy groups