alerts
Overview
| Name | alerts |
| Type | Resource |
| Id | pagerduty.incidents.alerts |
Fields
| Name | Datatype | Description |
|---|---|---|
id | string | |
_type | string | The type of object being created. |
alert_key | string | The alert's de-duplication key. |
body | object | A JSON object containing data describing the alert. |
created_at | string | The date/time the alert was first triggered. |
first_trigger_log_entry | object | |
html_url | string | a URL at which the entity is uniquely displayed in the Web app |
incident | object | |
integration | object | |
self | string | the API show URL at which the object is accessible |
service | object | |
severity | string | The magnitude of the problem as reported by the monitoring tool. |
status | string | The current status of the alert. |
summary | string | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier. |
suppressed | boolean | Whether or not an alert is suppressed. Suppressed alerts are not created with a parent incident. |
type | string | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by _reference if the object is a reference. |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get_incident_alert | SELECT | alert_id, id | Show detailed information about an alert. Accepts an alert id. An incident represents a problem or an issue that needs to be addressed and resolved. When a service sends an event to PagerDuty, an alert and corresponding incident is triggered in PagerDuty. For more information see the API Concepts Document Scoped OAuth requires: incidents.read |
list_incident_alerts | SELECT | id | List alerts for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the API Concepts Document Scoped OAuth requires: incidents.read |
_get_incident_alert | EXEC | alert_id, id | Show detailed information about an alert. Accepts an alert id. An incident represents a problem or an issue that needs to be addressed and resolved. When a service sends an event to PagerDuty, an alert and corresponding incident is triggered in PagerDuty. For more information see the API Concepts Document Scoped OAuth requires: incidents.read |
_list_incident_alerts | EXEC | id | List alerts for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the API Concepts Document Scoped OAuth requires: incidents.read |
update_incident_alert | EXEC | From, alert_id, id, data__alert | Resolve an alert or associate an alert with a new parent incident. An incident represents a problem or an issue that needs to be addressed and resolved. When a service sends an event to PagerDuty, an alert and corresponding incident is triggered in PagerDuty. For more information see the API Concepts Document Scoped OAuth requires: incidents.write |
update_incident_alerts | EXEC | From, id, data__alerts | Resolve multiple alerts or associate them with different incidents. An incident represents a problem or an issue that needs to be addressed and resolved. An alert represents a digital signal that was emitted to PagerDuty by the monitoring systems that detected or identified the issue. A maximum of 500 alerts may be updated at a time. If more than this number of alerts are given, the API will respond with status 413 (Request Entity Too Large). For more information see the API Concepts Document Scoped OAuth requires: incidents.write |