Routers

The Router Object

PropertyTypeDescription

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

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

default_receiver_router_id

string

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

default_receiver_team_id

string

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

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

Last updated