enablements
Creates, updates, deletes, gets or lists an enablements resource.
Overview
| Name | enablements |
| Type | Resource |
| Id | pagerduty.event_orchestrations.enablements |
Fields
The following fields are returned by SELECT queries:
- list
The list of feature enablement settings for the Event Orchestation.
| Name | Datatype | Description |
|---|---|---|
enabled | boolean | A boolean value indicating whether the specified product addon is enabled or disabled. |
feature | string | The name of the product addon whose set of features will be enabled or disabled. (example: aiops) |
updated_at | string (date-time) | The time the feature enablement was last updated. |
warnings | array | An array of warnings related to this feature enablement. Only present if warning conditions are met. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | id | List all feature enablement settings for an Event Orchestration. Currently, only the aiops enablement is supported.<br /><br />For any account with the AIOps product addon, every Event Orchestration will have AIOps features enabled by default.<br /><br />Warning conditions:<br />- If the account is not entitled to use AIOps features, a warning will be returned alongside the enablement data.<br /><br />Scoped OAuth requires: event_orchestrations.read<br /> | |
update | update | id, feature_name, enablement | Update the feature enablement setting for a specific product addon on an Event Orchestration. This setting controls enabling or disabling the set of features contained within the addon.<br />Currently, only aiops is supported as a valid feature enablement.<br /><br />Warning conditions:<br />- If the account is not entitled to use AIOps features, the setting will be updated, but a warning will be returned.<br /><br />Scoped OAuth requires: event_orchestrations.write<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 |
|---|---|---|
feature_name | string | The feature enablement identifier, typically the name of the product addon. Currently only aiops is supported. |
id | string | The ID of an Event Orchestration. |
SELECT examples
- list
List all feature enablement settings for an Event Orchestration. Currently, only the aiops enablement is supported.<br /><br />For any account with the AIOps product addon, every Event Orchestration will have AIOps features enabled by default.<br /><br />Warning conditions:<br />- If the account is not entitled to use AIOps features, a warning will be returned alongside the enablement data.<br /><br />Scoped OAuth requires: event_orchestrations.read<br />
SELECT
enabled,
feature,
updated_at,
warnings
FROM pagerduty.event_orchestrations.enablements
WHERE id = '{{ id }}' -- required
;
UPDATE examples
- update
Update the feature enablement setting for a specific product addon on an Event Orchestration. This setting controls enabling or disabling the set of features contained within the addon.<br />Currently, only aiops is supported as a valid feature enablement.<br /><br />Warning conditions:<br />- If the account is not entitled to use AIOps features, the setting will be updated, but a warning will be returned.<br /><br />Scoped OAuth requires: event_orchestrations.write<br />
UPDATE pagerduty.event_orchestrations.enablements
SET
enablement = '{{ enablement }}'
WHERE
id = '{{ id }}' --required
AND feature_name = '{{ feature_name }}' --required
AND enablement = '{{ enablement }}' --required
RETURNING
enablement;