Skip to content

Commit 9ced800

Browse files
authored
docs: Add the type parameter to the create_alert docs (#168)
1 parent a869c05 commit 9ced800

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

sdcclient/_monitor.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ def create_alert(self, name=None, description=None, severity=None, for_atleast_s
102102
- **enabled**: if True, the alert will be enabled when created.
103103
- **annotations**: an optional dictionary of custom properties that you can associate to this alert for automation or management reasons
104104
- **alert_obj**: an optional fully-formed Alert object of the format returned in an "alerts" list by :func:`~SdcClient.get_alerts` This is an alternative to creating the Alert using the individual parameters listed above.
105+
- **type**: the type of the alert, "MANUAL" if the alert uses a normal query, "PROMETHEUS" if it's PromQL
105106
106107
**Success Return Value**
107108
A dictionary describing the just created alert, with the format described at `this link <https://app.sysdigcloud.com/apidocs/#!/Alerts/post_api_alerts>`__

0 commit comments

Comments
 (0)