Delete an alert source

{ "data": { "id": "<string>", "type": "alert_sources", "attributes": { "name": "<string>", "status": "connected", "secret": "<string>", "created_at": "<string>", "updated_at": "<string>", "source_type": "email", "alert_urgency_id": "<string>", "deduplicate_alerts_by_key": true, "deduplication_key_kind": "payload", "deduplication_key_path": "<string>", "deduplication_key_regexp": "<string>", "owner_group_ids": [ "<string>" ], "alert_template_attributes": { "title": "<string>", "description": "<string>", "external_url": "<string>" }, "alert_source_urgency_rules_attributes": [ { "json_path": "<string>", "operator": "is", "value": "<string>", "conditionable_type": "AlertField", "conditionable_id": "<string>", "kind": "payload", "alert_urgency_id": "<string>" } ], "sourceable_attributes": { "auto_resolve": true, "resolve_state": "<string>", "accept_threaded_emails": true, "field_mappings_attributes": [ { "field": "external_id", "json_path": "<string>" } ] }, "resolution_rule_attributes": { "enabled": true, "condition_type": "all", "identifier_matchable_type": "AlertField", "identifier_matchable_id": "<string>", "identifier_reference_kind": "payload", "identifier_json_path": "<string>", "identifier_value_regex": "<string>", "conditions_attributes": [ { "field": "<string>", "operator": "is", "value": "<string>", "conditionable_type": "AlertField", "conditionable_id": "<string>", "kind": "payload" } ] }, "alert_source_fields_attributes": [ { "alert_field_id": "<string>", "template_body": "<string>" } ], "email": "<string>", "webhook_endpoint": "<string>" } } }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Response

alert source deleted

data

object

required

Show child attributes

data.id

string

required

Unique ID of the alert source

data.type

enum<string>

required

Available options:

alert_sources

data.attributes

object

required

Show child attributes

data.attributes.name

string

required

The name of the alert source

data.attributes.status

enum<string>

required

The status of the alert source

Available options:

connected,

setup_complete,

setup_incomplete

data.attributes.secret

string

required

The secret used to authenticate non-email alert sources

data.attributes.created_at

string

required

Date of creation

data.attributes.updated_at

string

required

Date of last update

data.attributes.source_type

enum<string>

The alert source type

Available options:

email,

app_dynamics,

catchpoint,

datadog,

alertmanager,

google_cloud,

grafana,

sentry,

generic_webhook,

cloud_watch,

checkly,

azure,

new_relic,

splunk,

chronosphere,

app_optics,

bug_snag,

honeycomb,

monte_carlo,

nagios,

prtg

data.attributes.alert_urgency_id

string

ID for the default alert urgency assigned to this alert source

data.attributes.deduplicate_alerts_by_key

boolean

Toggle alert deduplication using deduplication key. If enabled, deduplication_key_kind and deduplication_key_path are required.

data.attributes.deduplication_key_kind

enum<string>

Kind of deduplication key.

Available options:

payload

data.attributes.deduplication_key_path

string | null

Path to deduplication key. This is a JSON Path to extract the deduplication key from the request body.

data.attributes.deduplication_key_regexp

string | null

Regular expression to extract key from value found at key path.

data.attributes.owner_group_ids

string[]

List of team IDs that will own the alert source

data.attributes.alert_template_attributes

object

Show child attributes

data.attributes.alert_template_attributes.title

string | null

The alert title.

data.attributes.alert_template_attributes.description

string | null

The alert description.

data.attributes.alert_template_attributes.external_url

string | null

The alert URL.

data.attributes.alert_source_urgency_rules_attributes

object[]

List of rules that define the conditions under which the alert urgency will be set automatically based on the alert payload

Show child attributes

data.attributes.alert_source_urgency_rules_attributes.json_path

string | null

JSON path expression to extract a specific value from the alert's payload for evaluation

data.attributes.alert_source_urgency_rules_attributes.operator

enum<string>

Comparison operator used to evaluate the extracted value against the specified condition

Available options:

is,

is_not,

contains,

does_not_contain

data.attributes.alert_source_urgency_rules_attributes.value

string

Value that the extracted payload data is compared to using the specified operator to determine a match

data.attributes.alert_source_urgency_rules_attributes.conditionable_type

enum<string> | null

The type of the conditionable

Available options:

AlertField

data.attributes.alert_source_urgency_rules_attributes.conditionable_id

string | null

The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field.

data.attributes.alert_source_urgency_rules_attributes.kind

enum<string>

The kind of the conditionable

Available options:

payload,

alert_field

data.attributes.alert_source_urgency_rules_attributes.alert_urgency_id

string

The ID of the alert urgency

data.attributes.sourceable_attributes

object

Provide additional attributes for generic_webhook alerts source

Show child attributes

data.attributes.sourceable_attributes.auto_resolve

boolean

Set this to true to auto-resolve alerts based on field_mappings_attributes conditions

data.attributes.sourceable_attributes.resolve_state

string | null

This value is matched with the value extracted from alerts payload using JSON path in field_mappings_attributes

data.attributes.sourceable_attributes.accept_threaded_emails

boolean

Set this to false to reject threaded emails

data.attributes.sourceable_attributes.field_mappings_attributes

object[]

Specify rules to auto resolve alerts

Show child attributes

data.attributes.sourceable_attributes.field_mappings_attributes.field

enum<string>

Select the field on which the condition to be evaluated

Available options:

external_id,

state,

alert_title,

alert_description,

alert_external_url,

notification_target_type,

notification_target_id

data.attributes.sourceable_attributes.field_mappings_attributes.json_path

string

JSON path expression to extract a specific value from the alert's payload for evaluation

data.attributes.resolution_rule_attributes

object

Provide additional attributes for email alerts source

Show child attributes

data.attributes.resolution_rule_attributes.enabled

boolean

Set this to true to enable the auto resolution rule

data.attributes.resolution_rule_attributes.condition_type

enum<string>

The type of condition to evaluate to apply auto resolution rule

Available options:

all,

any

data.attributes.resolution_rule_attributes.identifier_matchable_type

enum<string> | null

The type of the identifier matchable

Available options:

AlertField

data.attributes.resolution_rule_attributes.identifier_matchable_id

string | null

The ID of the identifier matchable. If identifier_matchable_type is AlertField, this is the ID of the alert field.

data.attributes.resolution_rule_attributes.identifier_reference_kind

enum<string>

The kind of the identifier reference

Available options:

payload,

alert_field

data.attributes.resolution_rule_attributes.identifier_json_path

string | null

JSON path expression to extract unique alert identifier used to match triggered alerts with resolving alerts

data.attributes.resolution_rule_attributes.identifier_value_regex

string | null

Regex group to further specify the part of the string used as a unique identifier

data.attributes.resolution_rule_attributes.conditions_attributes

object[]

List of conditions to evaluate for auto resolution

Show child attributes

data.attributes.resolution_rule_attributes.conditions_attributes.field

string | null

JSON path expression to extract a specific value from the alert's payload for evaluation

data.attributes.resolution_rule_attributes.conditions_attributes.operator

enum<string>

Comparison operator used to evaluate the extracted value against the specified condition

Available options:

is,

is_not,

contains,

does_not_contain,

starts_with,

ends_with

data.attributes.resolution_rule_attributes.conditions_attributes.value

string

Value that the extracted payload data is compared to using the specified operator to determine a match

data.attributes.resolution_rule_attributes.conditions_attributes.conditionable_type

enum<string> | null

The type of the conditionable

Available options:

AlertField

data.attributes.resolution_rule_attributes.conditions_attributes.conditionable_id

string | null

The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field.

data.attributes.resolution_rule_attributes.conditions_attributes.kind

enum<string>

The kind of the conditionable

Available options:

payload,

alert_field

data.attributes.alert_source_fields_attributes

object[]

List of alert fields to be added to the alert source

Show child attributes

data.attributes.alert_source_fields_attributes.alert_field_id

string

The ID of the alert field

data.attributes.alert_source_fields_attributes.template_body

string | null

Liquid expression to extract a specific value from the alert's payload for evaluation

data.attributes.email

string | null

The email generated for email alert sources

data.attributes.webhook_endpoint

string | null

The webhook URL generated for non-email alert sources

Overview

AlertEvents

AlertFields

AlertGroups

AlertRoutes

AlertRoutingRules

AlertUrgencies

AlertSources

Alerts

Audits

Authorizations

CatalogEntities

CatalogEntityProperties

CatalogFields

Catalogs

Causes

Communications Groups

Communications Stages

Communications Templates

Communications Types

[DEPRECATED] CustomFieldOptions

[DEPRECATED] CustomFields

CustomForms

DashboardPanels

Dashboards

Environments

EscalationPolicies

EscalationLevelsPolicies

EscalationLevelsPath

EscalationLevels

EscalationPaths

FormFieldOptions

FormFieldPlacementConditions

FormFieldPlacements

FormFieldPositions

FormFields

FormSetConditions

FormSets

Functionalities

WorkflowTasks

[DEPRECATED] WorkflowCustomFieldSelections

WorkflowFormFieldConditions

WorkflowGroups

WorkflowRuns

Workflows

Heartbeats

IncidentActionItems

[DEPRECATED] IncidentCustomFieldSelections

IncidentEventFunctionalities

IncidentEventServices

IncidentEvents

IncidentFeedbacks

IncidentFormFieldSelections

IncidentPermissionSetBooleans

IncidentPermissionSetResources

IncidentPermissionSets

IncidentRetrospectives

IncidentRetrospectiveSteps

IncidentRoleTasks

IncidentRoles

IncidentStatusPageEvents

IncidentSubStatuses

IncidentTypes

Incidents

IpRanges

LiveCallRouters

OnCallRoles

OnCallShadows

OverrideShifts

PlaybookTasks

Playbooks

RetrospectiveTemplates

Pulses

RetrospectiveConfigurations

RetrospectiveProcessGroupSteps

RetrospectiveProcessGroups

RetrospectiveProcesses

RetrospectiveSteps

Roles

ScheduleRotationActiveDays