Skip to content

fix for multiple action_configs for alert rule creation #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 10, 2025
Merged

fix for multiple action_configs for alert rule creation #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
582d04d
fix for multiple action_configs for alert rule creation
SeaBlooms Sep 10, 2025
b1ad53b
bump version to 1.6.1 bugfix
SeaBlooms Sep 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions examples/05_alert_rules_and_smartclasses.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def alert_rule_examples(j1):
severity="HIGH",
j1ql="FIND Database WITH encrypted = false"
)
print(f"Created basic alert rule: {basic_rule['rule']['_id']}\n")
print(f"Created basic alert rule: {basic_rule['id']}\n")

# 2. Complex alert rule with multiple conditions
print("2. Creating a complex alert rule:")
Expand All @@ -55,7 +55,7 @@ def alert_rule_examples(j1):
AND u.tag.Role != 'admin'
"""
)
print(f"Created complex alert rule: {complex_rule['rule']['_id']}\n")
print(f"Created complex alert rule: {complex_rule['id']}\n")

return basic_rule, complex_rule

Expand Down Expand Up @@ -135,7 +135,7 @@ def alert_rule_with_actions_examples(j1):
j1ql="FIND Finding WITH severity = 'HIGH'",
action_configs=webhook_action_config
)
print(f"Created webhook alert rule: {webhook_rule['rule']['_id']}\n")
print(f"Created webhook alert rule: {webhook_rule['id']}\n")

# Create alert rule with multiple actions
print("2. Creating alert rule with multiple actions:")
Expand All @@ -149,7 +149,7 @@ def alert_rule_with_actions_examples(j1):
j1ql="FIND Finding WITH severity = ('HIGH' OR 'CRITICAL')",
action_configs=multiple_actions
)
print(f"Created multi-action alert rule: {multi_action_rule['rule']['_id']}\n")
print(f"Created multi-action alert rule: {multi_action_rule['id']}\n")

return webhook_rule, multi_action_rule

Expand All @@ -162,16 +162,16 @@ def alert_rule_management_examples(j1, rule_id):
print("1. Getting alert rule details:")
try:
rule_details = j1.get_alert_rule_details(rule_id=rule_id)
print(f"Rule: {rule_details['rule']['name']}")
print(f"Description: {rule_details['rule']['description']}")
print(f"J1QL: {rule_details['rule']['j1ql']}")
print(f"Severity: {rule_details['rule']['severity']}")
print(f"Polling Interval: {rule_details['rule']['pollingInterval']}")
print(f"Rule: {rule_details['name']}")
print(f"Description: {rule_details['description']}")
print(f"J1QL: {rule_details.get('j1ql', 'N/A')}")
print(f"Severity: {rule_details.get('severity', 'N/A')}")
print(f"Polling Interval: {rule_details.get('pollingInterval', 'N/A')}")

# Check action configurations
if 'actionConfigs' in rule_details['rule']:
if 'actionConfigs' in rule_details:
print("Action Configurations:")
for action in rule_details['rule']['actionConfigs']:
for action in rule_details['actionConfigs']:
print(f" Type: {action['type']}")
if action['type'] == 'WEBHOOK':
print(f" Endpoint: {action['endpoint']}")
Expand Down Expand Up @@ -208,7 +208,7 @@ def alert_rule_management_examples(j1, rule_id):
tag_op="OVERWRITE",
severity="INFO"
)
print(f"Updated alert rule: {updated_rule['rule']['_id']}")
print(f"Updated alert rule: {updated_rule['id']}")
except Exception as e:
print(f"Error updating alert rule: {e}")
print()
Expand Down Expand Up @@ -240,7 +240,7 @@ def smartclass_examples(j1):
smartclass_name='ProductionServers',
smartclass_description='All production servers across cloud providers'
)
smartclass_id = smartclass['smartclass']['_id']
smartclass_id = smartclass['id']
print(f"Created SmartClass: {smartclass_id}\n")

# 2. Add queries to SmartClass
Expand All @@ -267,8 +267,8 @@ def smartclass_examples(j1):
print("3. Getting SmartClass details:")
try:
smartclass_details = j1.get_smartclass_details(smartclass_id=smartclass_id)
print(f"SmartClass: {smartclass_details['smartclass']['name']}")
print(f"Description: {smartclass_details['smartclass']['description']}")
print(f"SmartClass: {smartclass_details['tagName']}")
print(f"Description: {smartclass_details['description']}")
print(f"Queries: {len(smartclass_details.get('queries', []))}")

# List all queries in the SmartClass
Expand Down Expand Up @@ -410,7 +410,7 @@ def main():
webhook_rule, multi_action_rule = alert_rule_with_actions_examples(j1)

# Alert rule management (using the basic rule)
alert_rule_management_examples(j1, basic_rule['rule']['_id'])
alert_rule_management_examples(j1, basic_rule['id'])

# SmartClass examples
smartclass_id = smartclass_examples(j1)
Expand All @@ -419,7 +419,7 @@ def main():
natural_language_to_j1ql_examples(j1)

# Alert rule evaluation examples
alert_rule_evaluation_examples(j1, basic_rule['rule']['_id'])
alert_rule_evaluation_examples(j1, basic_rule['id'])

# Compliance framework examples
compliance_framework_examples(j1)
Expand Down
23 changes: 17 additions & 6 deletions jupiterone/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1030,7 +1030,7 @@ def create_alert_rule(
polling_interval: str = None,
severity: str = None,
j1ql: str = None,
action_configs: Dict = None,
action_configs: Union[Dict, List[Dict]] = None,
resource_group_id: str = None,
):
"""Create Alert Rule Configuration in J1 account"""
Expand Down Expand Up @@ -1079,7 +1079,10 @@ def create_alert_rule(
}

if action_configs:
variables["instance"]["operations"][0]["actions"].append(action_configs)
if isinstance(action_configs, list):
variables["instance"]["operations"][0]["actions"].extend(action_configs)
else:
variables["instance"]["operations"][0]["actions"].append(action_configs)

response = self._execute_query(CREATE_RULE_INSTANCE, variables=variables)

Expand All @@ -1106,7 +1109,7 @@ def update_alert_rule(
tags: List[str] = None,
tag_op: str = None,
labels: List[dict] = None,
action_configs: List[dict] = None,
action_configs: Union[Dict, List[Dict]] = None,
action_configs_op: str = None,
resource_group_id: str = None,
):
Expand Down Expand Up @@ -1178,15 +1181,23 @@ def update_alert_rule(
alert_action_configs = []
base_action = alert_rule_config["operations"][0]["actions"][0]
alert_action_configs.append(base_action)
alert_action_configs.extend(action_configs)

# Handle both single dict and list of dicts
if isinstance(action_configs, list):
alert_action_configs.extend(action_configs)
else:
alert_action_configs.append(action_configs)

# update actions field inside operations payload
operations[0]["actions"] = alert_action_configs

elif action_configs_op == "APPEND":

# update actions field inside operations payload
operations[0]["actions"].extend(action_configs)
# Handle both single dict and list of dicts
if isinstance(action_configs, list):
operations[0]["actions"].extend(action_configs)
else:
operations[0]["actions"].append(action_configs)

# update alert severity if provided
if severity is not None:
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

setup(
name="jupiterone",
version="1.6.0",
version="1.6.1",
description="A Python client for the JupiterOne API",
license="MIT License",
author="JupiterOne",
Expand Down
Loading