Skip to main content
PUT
Update
🔑 Requires the alert_source.update scope.

Authorizations

Authorization
string
header
required

API key from your incident.io dashboard (Settings → API keys)

Path Parameters

id
string
required

The ID of this alert source

Example:

"01GW2G3V0S59R238FAHPDS1R66"

Body

application/json
name
string
required

Unique name of the alert source

Example:

"Production Web Dashboard Alerts"

template
object
required
Example:
auto_resolve_incident_alerts
boolean

Whether alerts from this source keep counting down to auto-resolve while attached to an incident. Defaults to true. Has no effect without auto_resolve_timeout_minutes.

Example:

false

auto_resolve_timeout_minutes
integer<int64>

When set, alerts from this source will automatically resolve after this many minutes.

Example:

1

azure_devops_options
object
Example:
disabled
boolean

For heartbeat sources, set to true to disable monitoring

Example:

false

email_options
object
Example:
filter_condition_groups
object[]

Conditions an incoming event must match to be ingested from this source, evaluated against the event's payload and this source's expressions. When empty, everything is ingested; otherwise a firing event that doesn't match is dropped and never creates or updates an alert. Resolve events are never filtered. Omit to leave unchanged.

Example:
fixed_team_id
string

Fix the team every alert from this source is attributed to. While set, the team attribute is managed from this field: a team binding sent in the template is ignored. Omit to leave unchanged; set to an empty string to clear it, making the team attribute editable again.

Example:

"01G0J1EXE7AXZ2C93K61WBPYEH"

heartbeat_options
object
Example:
http_custom_options
object
Example:
jira_options
object
Example:
owning_team_ids
string[]

IDs of teams that own this alert source

Example:
rate_limit_sharding
object

Controls how this source's ingest rate limit is split into buckets.

Example:

Response

OK response.

alert_source
object
required