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

Create an escalation policy

Returns either a newly created escalation policy, or validation errors.

POST https://uptime.betterstack.com/api/v2/policies

Headers

Authorization
required string

Bearer $TOKEN

Content_Type
string

application/json

Body parameters

team_name
string

Required if using global API token to specify the team which should own the resource

name
required string

The name of this Policy.

repeat_count
integer

How long in seconds to wait before each repetition.

repeat_delay
integer

Incident token that can be used for manually reporting incidents.

steps
Array of PolicyStep

An array of escalation policy steps. See the list of escalation policy API parameters for details.

201

Returns newly created escalation policy

Response body

{
  "data": {
    "id": "456",
    "type": "policy",
    "attributes": {
      "name": "Policy A",
      "repeat_count": 5,
      "repeat_delay": 0,
      "incident_token": "8nEiLj2gfqjfQRK6vzkFuGC25",
      "policy_group_id": null,
      "team_name": "Test team"
    },
    "steps": [
      {
        "type": "escalation",
        "wait_before": 0,
        "urgency_id": 12345,
        "step_members": [
          {
            "type": "all_slack_integrations"
          },
          {
            "type": "current_on_call"
          }
        ]
      }
    ]
  }
}

Example cURL

Example
curl -X "POST" "https://uptime.betterstack.com/api/v2/policies/" \
-H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json; charset=utf-8' \
-d $'{ "name": "Test" }'

Previous article

Get a single escalation policy

Next article

Update an escalation policy