event_enrichment_rules
Creates, updates, deletes, gets or lists an event_enrichment_rules resource.
Overview
| Name | event_enrichment_rules |
| Type | Resource |
| Id | pagerduty.enrichment.event_enrichment_rules |
Fields
The following fields are returned by SELECT queries:
- get
The Event Enrichment rules (orchestration path).
| Name | Datatype | Description |
|---|---|---|
created_at | string (date-time) | The date/time the rules were created. |
created_by | object | Reference to the user that created the rules. |
parent | object | Reference to the parent Event Enrichment. |
self | string (url) | The API show URL at which the object is accessible. |
sets | array | An array of sets of rules. Must contain a set with id start. |
type | string | The type of this orchestration path. (event_enrichment) |
updated_at | string (date-time) | The date/time the rules were last updated. |
updated_by | object | Reference to the user that last updated the rules. |
version | string | Version of the rules configuration. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | id | Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields.<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Get the rules associated with an Event Enrichment.<br /> | |
update | update | id, orchestration_path | Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields.<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Update the enrichment rules for a specific Event Enrichment. Performs a full replacement of the rules set.<br /> |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
id | string | The ID of the Event Enrichment. |
SELECT examples
- get
Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields.<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Get the rules associated with an Event Enrichment.<br />
SELECT
created_at,
created_by,
parent,
self,
sets,
type,
updated_at,
updated_by,
version
FROM pagerduty.enrichment.event_enrichment_rules
WHERE id = '{{ id }}' -- required
;
UPDATE examples
- update
Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields.<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Update the enrichment rules for a specific Event Enrichment. Performs a full replacement of the rules set.<br />
UPDATE pagerduty.enrichment.event_enrichment_rules
SET
orchestration_path = '{{ orchestration_path }}'
WHERE
id = '{{ id }}' --required
AND orchestration_path = '{{ orchestration_path }}' --required
RETURNING
orchestration_path;