---
title: "Update incident settings"
method: PATCH
path: "/incident_settings"
tags: ["Incident settings"]
---

# Update incident settings

`PATCH /incident_settings`

## Request

- Base URL: `https://app.getorchestra.io/api/engine/public`
- URL: `https://app.getorchestra.io/api/engine/public/incident_settings`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://app.getorchestra.io/oauth/authorize`
    - Token URL: `https://app.getorchestra.io/oauth/token` scopes: `orchestra:write`

Change the workspace's incident settings and return all of them. Settings left out of the body keep their current value.

## Headers

- `X-Orchestra-Account-Id` string, uuid4, nullable

## Request body

- PatchIncidentSettingsRequest: Request to change an account's incident settings. Omitted toggles keep their stored value; an unknown rule key is rejected.
  - `incidentsEnabled` boolean
  - `requireAlertConfigured` boolean
  - `requireDefaultBranchOrPublishedVersion` boolean: Only raise incidents for runs on a Git-backed pipeline's default branch, or of an Orchestra-backed pipeline's published version.
  - `environmentIds` string[]: Only failures from these environments open or join an incident; leave it empty for every environment.
  - `warningsEnabled` boolean
  - `groupWarningWithFailed` boolean
  - `autoResolveOnSuccess` boolean: Resolve an open incident once every resource it covers has succeeded again.
  - `maxAlertsPerIncident` integer: Cap on the number of live alerts sent for a single incident before further updates are rolled into a single rollup notice instead of sent individually. This budget applies to each alert destination.
  - `alertBudgetRefillCadence` 'never' | 'daily' | 'weekly': How often the per-incident alert budget comes back. Three named choices only - a free-form interval asks a first-time user for an opinion they do not have yet.
  - `autoDiagnoseIncidents` boolean: Have Orchestra's diagnoser investigate incidents as they open and grow.

## Response `200`

Successful Response

- IncidentSettingsResponse: An account's current incident settings.
  - `incidentsEnabled` boolean
  - `requireAlertConfigured` boolean
  - `requireDefaultBranchOrPublishedVersion` boolean: Only raise incidents for runs on a Git-backed pipeline's default branch, or of an Orchestra-backed pipeline's published version.
  - `environmentIds` string[]: Only failures from these environments open or join an incident; leave it empty for every environment.
  - `warningsEnabled` boolean
  - `groupWarningWithFailed` boolean
  - `autoResolveOnSuccess` boolean: Resolve an open incident once every resource it covers has succeeded again.
  - `maxAlertsPerIncident` integer: Cap on the number of live alerts sent for a single incident before further updates are rolled into a single rollup notice instead of sent individually. This budget applies to each alert destination.
  - `alertBudgetRefillCadence` 'never' | 'daily' | 'weekly': How often the per-incident alert budget comes back. Three named choices only - a free-form interval asks a first-time user for an opinion they do not have yet.
  - `autoDiagnoseIncidents` boolean: Have Orchestra's diagnoser investigate incidents as they open and grow.
  - `updatedAt` string, nullable

## Other responses

- `422`: Validation Error

## Changes

- **2026-11-03** `e45165e7e223`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/getorchestra/apis/orchestra-api/changes/incident_settings/patch.md)

---

[API](https://skmtc.dev/getorchestra/apis/orchestra-api.md) - [All operations](https://skmtc.dev/getorchestra/apis/orchestra-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getorchestra/apis/orchestra-api/revisions/daf2c16b3057?raw)