Update an alert rule

PATCH

/v:version/alert-rules/:resourceId

PATCH

/v:version/alert-rules/:resourceId

1 curl -X PATCH https://test.api.solvimon.com/v1/alert-rules/ \
2      -H "X-API-KEY: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "reference": "alert-rule-2024-06"
6 }'

1 {
2   "reference": "alert-rule-2024-06",
3   "object_type": "alert_rule",
4   "id": "ar-123e4567-e89b-12d3-a456-426614174000",
5   "name": "High CPU Usage Alert",
6   "description": "Triggers when CPU usage exceeds 90% for more than 5 minutes",
7   "status": "DRAFT",
8   "customer_ids": [
9     "cust-789e4567-e89b-12d3-a456-426614174001"
10   ],
11   "customers": [
12     {
13       "reference": "customer-001",
14       "type": "ORGANIZATION",
15       "email": "contact@acme-corp.com",
16       "roles": [
17         "DEFAULT",
18         "ADMIN"
19       ],
20       "object_type": "customer",
21       "id": "cust-789e4567-e89b-12d3-a456-426614174001",
22       "created_at": "2023-11-15T09:30:00Z",
23       "parent_customer_id": "cust-parent-001",
24       "parent_customer_ids": [
25         "cust-parent-001",
26         "cust-grandparent-001"
27       ],
28       "status": "ACTIVE",
29       "timezone": "America/New_York",
30       "notification_preferences": [
31         {
32           "type": "INVOICE",
33           "channels": [
34             {
35               "type": "EMAIL",
36               "enabled": true
37             }
38           ]
39         }
40       ],
41       "locale": "en-US",
42       "individual": {
43         "name": {
44           "first_name": "John",
45           "last_name": "Doe",
46           "infix": ""
47         },
48         "residential_address": {
49           "line1": "123 Elm Street",
50           "line2": "Suite 400",
51           "city": "Springfield",
52           "postal_code": "62704",
53           "state": "IL",
54           "country": "US"
55         }
56       },
57       "organization": {
58         "legal_name": "Acme Corporation",
59         "tax_id": "98-7654321",
60         "tax_ids": [
61           {
62             "id": "98-7654321",
63             "type": "EIN"
64           }
65         ],
66         "registration_number": "REG-456789",
67         "tax_exempt": false,
68         "tax_exempt_note": "",
69         "registered_address": {
70           "line1": "456 Oak Avenue",
71           "line2": "Floor 2",
72           "city": "Springfield",
73           "postal_code": "62701",
74           "state": "IL",
75           "country": "US"
76         }
77       },
78       "custom_fields": [
79         {
80           "id": "cf-001",
81           "reference": "preferred_contact_method",
82           "value": "email",
83           "values": [
84             "email",
85             "phone"
86           ],
87           "integration_details": {
88             "payment_gateway_variant": "STRIPE",
89             "id": "int-001",
90             "reference": "stripe-integration",
91             "adyen": {
92               "recurring_detail_reference": ""
93             },
94             "stripe": {
95               "payment_method_id": "pm_1GqIC8Lz0qyl6XeW3xYz1234"
96             }
97           }
98         }
99       ],
100       "processing_only": false,
101       "pricing_plan_subscription_selector": {
102         "data": [
103           {
104             "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
105             "value": "US"
106           }
107         ],
108         "rules": [
109           {
110             "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
111             "type": "EQUALS"
112           }
113         ],
114         "filters": [
115           {
116             "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
117             "type": "EQUALS",
118             "value": "US"
119           }
120         ],
121         "fallback": "LATEST"
122       },
123       "linked_integrations": [
124         {
125           "id": "int-001",
126           "link_details": [
127             {
128               "url": "https://dashboard.stripe.com/customers/cus_123456789",
129               "custom_field_name": "Stripe Customer ID"
130             }
131           ]
132         }
133       ]
134     }
135   ],
136   "type": "ENTITLEMENT",
137   "trigger_type": "STATIC",
138   "entitlement": {
139     "feature_id": "feat-001",
140     "comparator": "EQUALS",
141     "feature": {
142       "reference": "cpu_usage_feature",
143       "object_type": "feature",
144       "id": "feat-001",
145       "name": "CPU Usage Monitoring",
146       "description": "Feature to monitor CPU usage metrics",
147       "type": "SWITCH",
148       "enum_values": [
149         "ENABLED",
150         "DISABLED"
151       ],
152       "meter_value_calculation_id": "calc-001",
153       "meter_value_calculation": {
154         "reference": "sum_cpu_usage",
155         "object_type": "calculation",
156         "id": "calc-001",
157         "name": "Sum CPU Usage",
158         "description": "Calculates total CPU usage over time",
159         "calculation_type": "SUM",
160         "persist": true,
161         "meter_id": "meter-001",
162         "meter": {
163           "reference": "cpu_meter",
164           "object_type": "meter",
165           "id": "meter-001",
166           "name": "CPU Meter",
167           "description": "Meter tracking CPU usage",
168           "status": "DRAFT",
169           "meter_values": [
170             {
171               "id": "mv-001",
172               "object": {
173                 "reference": "cpu_percent",
174                 "object_type": "meter_value",
175                 "id": "mv-001",
176                 "name": "CPU Percentage",
177                 "description": "Percentage of CPU used",
178                 "status": "DRAFT",
179                 "type": "NUMBER"
180               },
181               "required": true
182             }
183           ],
184           "meter_properties": [
185             {
186               "id": "mp-001",
187               "object": {
188                 "reference": "cpu_core_count",
189                 "status": "DRAFT",
190                 "object_type": "meter_property",
191                 "id": "mp-001",
192                 "name": "CPU Core Count",
193                 "description": "Number of CPU cores",
194                 "type": "NUMBER",
195                 "enum_values": []
196               },
197               "required": true
198             }
199           ]
200         },
201         "meter_value_id": "mv-001",
202         "meter_value": {
203           "reference": "cpu_percent",
204           "object_type": "meter_value",
205           "id": "mv-001",
206           "name": "CPU Percentage",
207           "description": "Percentage of CPU used",
208           "status": "DRAFT",
209           "type": "NUMBER"
210         },
211         "meter_property_id": "mp-001",
212         "meter_property": {
213           "reference": "cpu_core_count",
214           "status": "DRAFT",
215           "object_type": "meter_property",
216           "id": "mp-001",
217           "name": "CPU Core Count",
218           "description": "Number of CPU cores",
219           "type": "NUMBER",
220           "enum_values": []
221         }
222       }
223     },
224     "threshold": {
225       "number": "90",
226       "percentage": "0.9",
227       "amount": {
228         "quantity": "100",
229         "currency": "AED"
230       }
231     }
232   },
233   "invoice": {
234     "variant": "OVERDUE",
235     "overdue": {
236       "comparator": "EQUALS",
237       "threshold": {
238         "type": "DAY",
239         "value": 7
240       }
241     }
242   }
243 }

Requires the ALERT_RULE.UPDATE permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

Request

This endpoint expects an object.

referencestringRequiredformat: "^\S+$"0-256 characters

A custom reference assigned to the alert.

namestring or nullOptionalformat: "^.*$"0-256 characters

A custom name assigned to the alert.

descriptionstring or nullOptionalformat: "^.*$"0-256 characters

statusenum or nullOptional

The status of the AlertRule. DEPRECATED is not supported.

Allowed values:

customer_idslist of strings or nullOptional

The IDs of the customers linked to the alert.

typeenum or nullOptional

The type of the the alert.

Allowed values:

trigger_typeenum or nullOptional

Allowed values:

entitlementobjectOptional

The specification of the entitlement for the alert, can only be specified when type is ENTITLEMENT

invoiceobjectOptional

The specification of the invoice for the alert, can only be specified when type is INVOICE

Response

referencestringformat: "^\S+$"0-256 characters

A custom reference assigned to the alert.

object_typestring or nullRead-only

idstring or nullRead-only

namestring or nullformat: "^.*$"0-256 characters

A custom name assigned to the alert.

descriptionstring or nullformat: "^.*$"0-256 characters

statusenum or null

The status of the AlertRule. DEPRECATED is not supported.

Allowed values:

customer_idslist of strings or null

The IDs of the customers linked to the alert.

customerslist of objects or nullRead-only

typeenum or null

The type of the the alert.

Allowed values:

trigger_typeenum or null

Allowed values:

entitlementobject

The specification of the entitlement for the alert, can only be specified when type is ENTITLEMENT

invoiceobject

The specification of the invoice for the alert, can only be specified when type is INVOICE

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors