Send test alert

Fires a test alert to a verified, enabled channel. The optional body names the monitor the test was fired from. Capped at 5 test alerts per account per hour (429 beyond that); an unverified or disabled channel returns 400.

post/alert_channels/{id}/test

Request

  • Base URL: https://app.yoping.me/api/v1
  • URL: https://app.yoping.me/api/v1/alert_channels/{id}/test
  • Auth: API key in cookie yp_session

Path parameters

idstring required

Resource id. Ids belonging to another account behave as missing (404).

Request body

monitor_idstring

Optional monitor the test was fired from; the test alert names that monitor. An unknown or foreign id is ignored.

Response

Success with a human-readable message.

Changes

No recorded changes to this operation across all 1 revision of this API.