Docs
WebsiteLoginFree Trial
  • Getting Started
    • OnCall Users
    • Team Admins
    • Account Admins
  • Architecture Guide
  • Common UI Design Patterns
  • Alerts
  • Teams
  • Schedules
  • Escalation Policies
  • Integrations
  • Broadcasts
  • Users
  • Notifications
  • Reports
  • Billing
  • Accounts
  • Stakeholders
  • Maintenance Windows
  • Routers
  • Notification Rules
  • Single Sign On (SSO)
  • Integration Guides
    • Introduction
    • 66uptime
    • Apex Ping
    • AppDynamics
    • Auvik
    • AWS CloudWatch
    • Azure Monitor
    • Cloudflare
    • Cronitor
    • Datadog
    • Dead Man's Snitch
    • Echoes HQ
    • ElastAlert
    • Email
    • Form
    • Freshdesk
    • Freshservice
    • Google Hangouts Chat
    • Grafana
    • Healthchecks.io
    • HetrixTools
    • Honeybadger
    • Hydrozen
    • Jira Server
    • JotForm
    • Kapacitor
    • LogicMonitor
    • Mattermost
      • Outgoing Webhook
      • Post to Channel
    • Meta Workplace
    • Microsoft Teams
    • New Relic
    • Outgoing Webhook
    • Pingdom
    • Prometheus
    • PRTG Network Monitor
    • Pulsetic
    • Sentry
    • ServerGuard24
    • Site24x7
    • Slack
      • Notifications
      • Outgoing Webhook
      • Post to Channel
    • SolarWinds
    • Stackdriver
    • StatusCake
    • Twilio
      • Incoming SMS
      • Live Call Routing
    • Typeform
    • Uptime
    • Uptime Kuma
    • UptimeRobot
    • Webhook
    • Zendesk
  • API
    • Introduction
    • Authentication
    • Errors
    • Pagination and Filters
    • Common Model Attributes
    • Account Users
    • Alerts
    • Broadcasts
    • Comments
    • Escalation Policies
    • Events
    • Integrations
    • Logs
    • Maintenance Windows
    • Notification Rules
    • Routers
    • Schedules
    • Teams
    • Users
  • Command Line Interface (CLI)
    • PagerTree CLI: Command Line Interface
Powered by GitBook
On this page
  • The Router Object
  • Create a Router
  • Retrieve a Router
  • Update a Router
  • Delete a Router
  • List all Routers

Was this helpful?

  1. API

Routers

PreviousNotification RulesNextSchedules

Last updated 2 years ago

Was this helpful?

  • are simple YAML configurations that dictate how to route and transform .

  • Alerts can be sent to routers by or .

  • Routers are part of the in PagerTree. Please see the in-depth details on how to use them.

The Router Object

Property
Type
Description

name

string

The name of the router

enabled

boolean

Boolean indicating if this router is currently enabled. If false, it will just route to the default receiver.

rules

string

YAML definition of the router. See routers documentation.

default_receiver_account_user_id

string

default_receiver_router_id

string

default_receiver_team_id

string

Create a Router

POST https://api.pagertree.com/api/v4/routers

Allowed Parameters

def router_params
  params.permit(
    :name,
    :enabled,
    :rules,
    :default_receiver_account_user_id,
    :default_receiver_router_id,
    :default_receiver_team_id,
  )
end

Required Parameters

  • name

  • at least 1 default_receiver

Retrieve a Router

GET https://api.pagertree.com/api/v4/routers/:id

Update a Router

PUT https://api.pagertree.com/api/v4/routers/:id

Delete a Router

DELETE https://api.pagertree.com/api/v4/routers/:id

List all Routers

GET https://api.pagertree.com/api/v4/routers

The ID of the to receive the alert if no rules match.

The ID of the to receive the alert if no rules match.

The ID of the to receive the alert if no rules match.

Account User
Router
Team
Routers
Alerts
Integrations
Account Users
routers documentation
Advanced Functionality