---
title: "Update Index Rate Alert"
method: PUT
path: "/v1/config/index-rate"
tags: ["Index Rate Alert"]
---

# Update Index Rate Alert

`PUT /v1/config/index-rate`

Use this method to update an index rate alert. You can change the alert's configuration details.

## Request body

- IndexRateAlertConfigResponse
  - `max_lines` integer — The number of lines required in order to trigger the alert.
  - `max_z_score` integer — The number of standard deviations above the 30 day average lines in order to trigger the alert.
  - `threshold_alert` 'separate' | 'both' — Determines if you want alerts to be triggered if both the max lines and standard deviation have been triggered, or if one of the thresholds has been reached.
  - `frequency` 'hourly' | 'daily' — Notify recipients once per hour, or once per day, (starting when the threshold is passed the first time) until the index rate drops below the thresholds. When the index rate drops below the thresholds, alerting stops.
  - `channels` object
    - `email` Emails[]
    - `pagerduty` Key[]
    - `slack` Url[]
    - `webhook` IndexRateAlertWebhookConfigResponse[]
      - `url` string — Webhook URL.
      - `method` 'POST' | 'PUT' | 'PATCH' — WebHook method such as POST.
      - `headers` Headers
        - `timestamp` string — Header value
      - `bodyTemplate` string
  - `enabled` boolean

## Response `200`

OK

- IndexRateAlertConfigResponse
  - `max_lines` integer — The number of lines required in order to trigger the alert.
  - `max_z_score` integer — The number of standard deviations above the 30 day average lines in order to trigger the alert.
  - `threshold_alert` 'separate' | 'both' — Determines if you want alerts to be triggered if both the max lines and standard deviation have been triggered, or if one of the thresholds has been reached.
  - `frequency` 'hourly' | 'daily' — Notify recipients once per hour, or once per day, (starting when the threshold is passed the first time) until the index rate drops below the thresholds. When the index rate drops below the thresholds, alerting stops.
  - `channels` object
    - `email` Emails[]
    - `pagerduty` Key[]
    - `slack` Url[]
    - `webhook` IndexRateAlertWebhookConfigResponse[]
      - `url` string — Webhook URL.
      - `method` 'POST' | 'PUT' | 'PATCH' — WebHook method such as POST.
      - `headers` Headers
        - `timestamp` string — Header value
      - `bodyTemplate` string
  - `enabled` boolean

## Other responses

- `400` — Bad request
- `500` — Internal Server error occurred when trying to fetch index rate alerts

---

[API](https://skmtc.net/mezmo/apis/pipeline-api.md) · [All operations](https://skmtc.net/mezmo/apis/pipeline-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mezmo/pipeline-api/revisions/fb2535545d90/schema)