GEgetorchestra
Incident settings

Update incident settings

Changed on

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

patch/incident_settings

Request

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

Headers

X-Orchestra-Account-Idstring uuid4 nullable

Act on this account rather than the one the credential resolves to. Omit it to use the credential's own account. An API key is issued to a single account, so it may only name that account; an OAuth token may name any account its grant covers.

Request body

incidentsEnabledboolean
requireAlertConfiguredboolean
requireDefaultBranchOrPublishedVersionboolean

Only raise incidents for runs on a Git-backed pipeline's default branch, or of an Orchestra-backed pipeline's published version.

environmentIdsstring[]

Only failures from these environments open or join an incident; leave it empty for every environment.

warningsEnabledboolean
groupWarningWithFailedboolean
autoResolveOnSuccessboolean

Resolve an open incident once every resource it covers has succeeded again.

maxAlertsPerIncidentinteger

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.

autoDiagnoseIncidentsboolean

Have Orchestra's diagnoser investigate incidents as they open and grow.

Response

Successful Response

incidentsEnabledboolean
requireAlertConfiguredboolean
requireDefaultBranchOrPublishedVersionboolean

Only raise incidents for runs on a Git-backed pipeline's default branch, or of an Orchestra-backed pipeline's published version.

environmentIdsstring[]

Only failures from these environments open or join an incident; leave it empty for every environment.

warningsEnabledboolean
groupWarningWithFailedboolean
autoResolveOnSuccessboolean

Resolve an open incident once every resource it covers has succeeded again.

maxAlertsPerIncidentinteger

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.

autoDiagnoseIncidentsboolean

Have Orchestra's diagnoser investigate incidents as they open and grow.

updatedAtstring nullable

Changes