GitVita
New repositoryImport repositoryNew issue
Your repositories Your dashboard Sign in

cloudflare/cloudflare-typescript

Public

mirrored fromhttps://github.com/cloudflare/cloudflare-typescriptAvailable

Watch0Fork0Star0
CodeCommitsIssuesPull requestsActionsInsightsSecurity
v3.0.0-beta.13

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

cloudflare-typescript/src/resources/alerting

src/resources/alerting/policies.ts

1087lines · modecode

RawDownload
Latest commit unavailable.
1// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
3import * as Core from 'cloudflare/core';
4import { APIResource } from 'cloudflare/resource';
5import * as PoliciesAPI from 'cloudflare/resources/alerting/policies';
6
7export class Policies extends APIResource {
8 /**
9 * Creates a new Notification policy.
10 */
11 create(params: PolicyCreateParams, options?: Core.RequestOptions): Core.APIPromise<PolicyCreateResponse> {
12 const { account_id, ...body } = params;
13 return (
14 this._client.post(`/accounts/${account_id}/alerting/v3/policies`, {
15 body,
16 ...options,
17 }) as Core.APIPromise<{ result: PolicyCreateResponse }>
18 )._thenUnwrap((obj) => obj.result);
19 }
20
21 /**
22 * Update a Notification policy.
23 */
24 update(
25 policyId: string,
26 params: PolicyUpdateParams,
27 options?: Core.RequestOptions,
28 ): Core.APIPromise<PolicyUpdateResponse> {
29 const { account_id, ...body } = params;
30 return (
31 this._client.put(`/accounts/${account_id}/alerting/v3/policies/${policyId}`, {
32 body,
33 ...options,
34 }) as Core.APIPromise<{ result: PolicyUpdateResponse }>
35 )._thenUnwrap((obj) => obj.result);
36 }
37
38 /**
39 * Get a list of all Notification policies.
40 */
41 list(params: PolicyListParams, options?: Core.RequestOptions): Core.APIPromise<PolicyListResponse | null> {
42 const { account_id } = params;
43 return (
44 this._client.get(`/accounts/${account_id}/alerting/v3/policies`, options) as Core.APIPromise<{
45 result: PolicyListResponse | null;
46 }>
47 )._thenUnwrap((obj) => obj.result);
48 }
49
50 /**
51 * Delete a Notification policy.
52 */
53 delete(
54 policyId: string,
55 params: PolicyDeleteParams,
56 options?: Core.RequestOptions,
57 ): Core.APIPromise<PolicyDeleteResponse | null> {
58 const { account_id } = params;
59 return (
60 this._client.delete(
61 `/accounts/${account_id}/alerting/v3/policies/${policyId}`,
62 options,
63 ) as Core.APIPromise<{ result: PolicyDeleteResponse | null }>
64 )._thenUnwrap((obj) => obj.result);
65 }
66
67 /**
68 * Get details for a single policy.
69 */
70 get(
71 policyId: string,
72 params: PolicyGetParams,
73 options?: Core.RequestOptions,
74 ): Core.APIPromise<AaaPolicies> {
75 const { account_id } = params;
76 return (
77 this._client.get(
78 `/accounts/${account_id}/alerting/v3/policies/${policyId}`,
79 options,
80 ) as Core.APIPromise<{ result: AaaPolicies }>
81 )._thenUnwrap((obj) => obj.result);
82 }
83}
84
85export interface AaaPolicies {
86 /**
87 * The unique identifier of a notification policy
88 */
89 id?: string;
90
91 /**
92 * Refers to which event will trigger a Notification dispatch. You can use the
93 * endpoint to get available alert types which then will give you a list of
94 * possible values.
95 */
96 alert_type?:
97 | 'access_custom_certificate_expiration_type'
98 | 'advanced_ddos_attack_l4_alert'
99 | 'advanced_ddos_attack_l7_alert'
100 | 'advanced_http_alert_error'
101 | 'bgp_hijack_notification'
102 | 'billing_usage_alert'
103 | 'block_notification_block_removed'
104 | 'block_notification_new_block'
105 | 'block_notification_review_rejected'
106 | 'brand_protection_alert'
107 | 'brand_protection_digest'
108 | 'clickhouse_alert_fw_anomaly'
109 | 'clickhouse_alert_fw_ent_anomaly'
110 | 'custom_ssl_certificate_event_type'
111 | 'dedicated_ssl_certificate_event_type'
112 | 'dos_attack_l4'
113 | 'dos_attack_l7'
114 | 'expiring_service_token_alert'
115 | 'failing_logpush_job_disabled_alert'
116 | 'fbm_auto_advertisement'
117 | 'fbm_dosd_attack'
118 | 'fbm_volumetric_attack'
119 | 'health_check_status_notification'
120 | 'hostname_aop_custom_certificate_expiration_type'
121 | 'http_alert_edge_error'
122 | 'http_alert_origin_error'
123 | 'incident_alert'
124 | 'load_balancing_health_alert'
125 | 'load_balancing_pool_enablement_alert'
126 | 'logo_match_alert'
127 | 'magic_tunnel_health_check_event'
128 | 'maintenance_event_notification'
129 | 'mtls_certificate_store_certificate_expiration_type'
130 | 'pages_event_alert'
131 | 'radar_notification'
132 | 'real_origin_monitoring'
133 | 'scriptmonitor_alert_new_code_change_detections'
134 | 'scriptmonitor_alert_new_hosts'
135 | 'scriptmonitor_alert_new_malicious_hosts'
136 | 'scriptmonitor_alert_new_malicious_scripts'
137 | 'scriptmonitor_alert_new_malicious_url'
138 | 'scriptmonitor_alert_new_max_length_resource_url'
139 | 'scriptmonitor_alert_new_resources'
140 | 'secondary_dns_all_primaries_failing'
141 | 'secondary_dns_primaries_failing'
142 | 'secondary_dns_zone_successfully_updated'
143 | 'secondary_dns_zone_validation_warning'
144 | 'sentinel_alert'
145 | 'stream_live_notifications'
146 | 'traffic_anomalies_alert'
147 | 'tunnel_health_event'
148 | 'tunnel_update_event'
149 | 'universal_ssl_event_type'
150 | 'web_analytics_metrics_update'
151 | 'zone_aop_custom_certificate_expiration_type';
152
153 created?: string;
154
155 /**
156 * Optional description for the Notification policy.
157 */
158 description?: string;
159
160 /**
161 * Whether or not the Notification policy is enabled.
162 */
163 enabled?: boolean;
164
165 /**
166 * Optional filters that allow you to be alerted only on a subset of events for
167 * that alert type based on some criteria. This is only available for select alert
168 * types. See alert type documentation for more details.
169 */
170 filters?: AaaPolicies.Filters;
171
172 /**
173 * List of IDs that will be used when dispatching a notification. IDs for email
174 * type will be the email address.
175 */
176 mechanisms?: Record<string, Array<AaaPolicies.Mechanisms>>;
177
178 modified?: string;
179
180 /**
181 * Name of the policy.
182 */
183 name?: string;
184}
185
186export namespace AaaPolicies {
187 /**
188 * Optional filters that allow you to be alerted only on a subset of events for
189 * that alert type based on some criteria. This is only available for select alert
190 * types. See alert type documentation for more details.
191 */
192 export interface Filters {
193 /**
194 * Usage depends on specific alert type
195 */
196 actions?: Array<string>;
197
198 /**
199 * Used for configuring radar_notification
200 */
201 affected_asns?: Array<string>;
202
203 /**
204 * Used for configuring incident_alert. A list of identifiers for each component to
205 * monitor.
206 */
207 affected_components?: Array<string>;
208
209 /**
210 * Used for configuring radar_notification
211 */
212 affected_locations?: Array<string>;
213
214 /**
215 * Used for configuring maintenance_event_notification
216 */
217 airport_code?: Array<string>;
218
219 /**
220 * Usage depends on specific alert type
221 */
222 alert_trigger_preferences?: Array<string>;
223
224 /**
225 * Used for configuring magic_tunnel_health_check_event
226 */
227 alert_trigger_preferences_value?: Array<'99.0' | '98.0' | '97.0'>;
228
229 /**
230 * Used for configuring load_balancing_pool_enablement_alert
231 */
232 enabled?: Array<string>;
233
234 /**
235 * Used for configuring pages_event_alert
236 */
237 environment?: Array<string>;
238
239 /**
240 * Used for configuring pages_event_alert
241 */
242 event?: Array<string>;
243
244 /**
245 * Used for configuring load_balancing_health_alert
246 */
247 event_source?: Array<string>;
248
249 /**
250 * Usage depends on specific alert type
251 */
252 event_type?: Array<string>;
253
254 /**
255 * Usage depends on specific alert type
256 */
257 group_by?: Array<string>;
258
259 /**
260 * Used for configuring health_check_status_notification
261 */
262 health_check_id?: Array<string>;
263
264 /**
265 * Used for configuring incident_alert
266 */
267 incident_impact?: Array<
268 'INCIDENT_IMPACT_NONE' | 'INCIDENT_IMPACT_MINOR' | 'INCIDENT_IMPACT_MAJOR' | 'INCIDENT_IMPACT_CRITICAL'
269 >;
270
271 /**
272 * Used for configuring stream_live_notifications
273 */
274 input_id?: Array<string>;
275
276 /**
277 * Used for configuring billing_usage_alert
278 */
279 limit?: Array<string>;
280
281 /**
282 * Used for configuring logo_match_alert
283 */
284 logo_tag?: Array<string>;
285
286 /**
287 * Used for configuring advanced_ddos_attack_l4_alert
288 */
289 megabits_per_second?: Array<string>;
290
291 /**
292 * Used for configuring load_balancing_health_alert
293 */
294 new_health?: Array<string>;
295
296 /**
297 * Used for configuring tunnel_health_event
298 */
299 new_status?: Array<string>;
300
301 /**
302 * Used for configuring advanced_ddos_attack_l4_alert
303 */
304 packets_per_second?: Array<string>;
305
306 /**
307 * Usage depends on specific alert type
308 */
309 pool_id?: Array<string>;
310
311 /**
312 * Used for configuring billing_usage_alert
313 */
314 product?: Array<string>;
315
316 /**
317 * Used for configuring pages_event_alert
318 */
319 project_id?: Array<string>;
320
321 /**
322 * Used for configuring advanced_ddos_attack_l4_alert
323 */
324 protocol?: Array<string>;
325
326 /**
327 * Usage depends on specific alert type
328 */
329 query_tag?: Array<string>;
330
331 /**
332 * Used for configuring advanced_ddos_attack_l7_alert
333 */
334 requests_per_second?: Array<string>;
335
336 /**
337 * Usage depends on specific alert type
338 */
339 selectors?: Array<string>;
340
341 /**
342 * Used for configuring clickhouse_alert_fw_ent_anomaly
343 */
344 services?: Array<string>;
345
346 /**
347 * Usage depends on specific alert type
348 */
349 slo?: Array<string>;
350
351 /**
352 * Used for configuring health_check_status_notification
353 */
354 status?: Array<string>;
355
356 /**
357 * Used for configuring advanced_ddos_attack_l7_alert
358 */
359 target_hostname?: Array<string>;
360
361 /**
362 * Used for configuring advanced_ddos_attack_l4_alert
363 */
364 target_ip?: Array<string>;
365
366 /**
367 * Used for configuring advanced_ddos_attack_l7_alert
368 */
369 target_zone_name?: Array<string>;
370
371 /**
372 * Used for configuring traffic_anomalies_alert
373 */
374 traffic_exclusions?: Array<'security_events'>;
375
376 /**
377 * Used for configuring tunnel_health_event
378 */
379 tunnel_id?: Array<string>;
380
381 /**
382 * Used for configuring magic_tunnel_health_check_event
383 */
384 tunnel_name?: Array<string>;
385
386 /**
387 * Usage depends on specific alert type
388 */
389 where?: Array<string>;
390
391 /**
392 * Usage depends on specific alert type
393 */
394 zones?: Array<string>;
395 }
396
397 export interface Mechanisms {
398 /**
399 * UUID
400 */
401 id?: string | string;
402 }
403}
404
405export interface PolicyCreateResponse {
406 /**
407 * UUID
408 */
409 id?: string;
410}
411
412export interface PolicyUpdateResponse {
413 /**
414 * UUID
415 */
416 id?: string;
417}
418
419export type PolicyListResponse = Array<AaaPolicies>;
420
421export type PolicyDeleteResponse = unknown | Array<unknown> | string;
422
423export interface PolicyCreateParams {
424 /**
425 * Path param: The account id
426 */
427 account_id: string;
428
429 /**
430 * Body param: Refers to which event will trigger a Notification dispatch. You can
431 * use the endpoint to get available alert types which then will give you a list of
432 * possible values.
433 */
434 alert_type:
435 | 'access_custom_certificate_expiration_type'
436 | 'advanced_ddos_attack_l4_alert'
437 | 'advanced_ddos_attack_l7_alert'
438 | 'advanced_http_alert_error'
439 | 'bgp_hijack_notification'
440 | 'billing_usage_alert'
441 | 'block_notification_block_removed'
442 | 'block_notification_new_block'
443 | 'block_notification_review_rejected'
444 | 'brand_protection_alert'
445 | 'brand_protection_digest'
446 | 'clickhouse_alert_fw_anomaly'
447 | 'clickhouse_alert_fw_ent_anomaly'
448 | 'custom_ssl_certificate_event_type'
449 | 'dedicated_ssl_certificate_event_type'
450 | 'dos_attack_l4'
451 | 'dos_attack_l7'
452 | 'expiring_service_token_alert'
453 | 'failing_logpush_job_disabled_alert'
454 | 'fbm_auto_advertisement'
455 | 'fbm_dosd_attack'
456 | 'fbm_volumetric_attack'
457 | 'health_check_status_notification'
458 | 'hostname_aop_custom_certificate_expiration_type'
459 | 'http_alert_edge_error'
460 | 'http_alert_origin_error'
461 | 'incident_alert'
462 | 'load_balancing_health_alert'
463 | 'load_balancing_pool_enablement_alert'
464 | 'logo_match_alert'
465 | 'magic_tunnel_health_check_event'
466 | 'maintenance_event_notification'
467 | 'mtls_certificate_store_certificate_expiration_type'
468 | 'pages_event_alert'
469 | 'radar_notification'
470 | 'real_origin_monitoring'
471 | 'scriptmonitor_alert_new_code_change_detections'
472 | 'scriptmonitor_alert_new_hosts'
473 | 'scriptmonitor_alert_new_malicious_hosts'
474 | 'scriptmonitor_alert_new_malicious_scripts'
475 | 'scriptmonitor_alert_new_malicious_url'
476 | 'scriptmonitor_alert_new_max_length_resource_url'
477 | 'scriptmonitor_alert_new_resources'
478 | 'secondary_dns_all_primaries_failing'
479 | 'secondary_dns_primaries_failing'
480 | 'secondary_dns_zone_successfully_updated'
481 | 'secondary_dns_zone_validation_warning'
482 | 'sentinel_alert'
483 | 'stream_live_notifications'
484 | 'traffic_anomalies_alert'
485 | 'tunnel_health_event'
486 | 'tunnel_update_event'
487 | 'universal_ssl_event_type'
488 | 'web_analytics_metrics_update'
489 | 'zone_aop_custom_certificate_expiration_type';
490
491 /**
492 * Body param: Whether or not the Notification policy is enabled.
493 */
494 enabled: boolean;
495
496 /**
497 * Body param: List of IDs that will be used when dispatching a notification. IDs
498 * for email type will be the email address.
499 */
500 mechanisms: Record<string, Array<PolicyCreateParams.Mechanisms>>;
501
502 /**
503 * Body param: Name of the policy.
504 */
505 name: string;
506
507 /**
508 * Body param: Optional description for the Notification policy.
509 */
510 description?: string;
511
512 /**
513 * Body param: Optional filters that allow you to be alerted only on a subset of
514 * events for that alert type based on some criteria. This is only available for
515 * select alert types. See alert type documentation for more details.
516 */
517 filters?: PolicyCreateParams.Filters;
518}
519
520export namespace PolicyCreateParams {
521 export interface Mechanisms {
522 /**
523 * UUID
524 */
525 id?: string | string;
526 }
527
528 /**
529 * Optional filters that allow you to be alerted only on a subset of events for
530 * that alert type based on some criteria. This is only available for select alert
531 * types. See alert type documentation for more details.
532 */
533 export interface Filters {
534 /**
535 * Usage depends on specific alert type
536 */
537 actions?: Array<string>;
538
539 /**
540 * Used for configuring radar_notification
541 */
542 affected_asns?: Array<string>;
543
544 /**
545 * Used for configuring incident_alert. A list of identifiers for each component to
546 * monitor.
547 */
548 affected_components?: Array<string>;
549
550 /**
551 * Used for configuring radar_notification
552 */
553 affected_locations?: Array<string>;
554
555 /**
556 * Used for configuring maintenance_event_notification
557 */
558 airport_code?: Array<string>;
559
560 /**
561 * Usage depends on specific alert type
562 */
563 alert_trigger_preferences?: Array<string>;
564
565 /**
566 * Used for configuring magic_tunnel_health_check_event
567 */
568 alert_trigger_preferences_value?: Array<'99.0' | '98.0' | '97.0'>;
569
570 /**
571 * Used for configuring load_balancing_pool_enablement_alert
572 */
573 enabled?: Array<string>;
574
575 /**
576 * Used for configuring pages_event_alert
577 */
578 environment?: Array<string>;
579
580 /**
581 * Used for configuring pages_event_alert
582 */
583 event?: Array<string>;
584
585 /**
586 * Used for configuring load_balancing_health_alert
587 */
588 event_source?: Array<string>;
589
590 /**
591 * Usage depends on specific alert type
592 */
593 event_type?: Array<string>;
594
595 /**
596 * Usage depends on specific alert type
597 */
598 group_by?: Array<string>;
599
600 /**
601 * Used for configuring health_check_status_notification
602 */
603 health_check_id?: Array<string>;
604
605 /**
606 * Used for configuring incident_alert
607 */
608 incident_impact?: Array<
609 'INCIDENT_IMPACT_NONE' | 'INCIDENT_IMPACT_MINOR' | 'INCIDENT_IMPACT_MAJOR' | 'INCIDENT_IMPACT_CRITICAL'
610 >;
611
612 /**
613 * Used for configuring stream_live_notifications
614 */
615 input_id?: Array<string>;
616
617 /**
618 * Used for configuring billing_usage_alert
619 */
620 limit?: Array<string>;
621
622 /**
623 * Used for configuring logo_match_alert
624 */
625 logo_tag?: Array<string>;
626
627 /**
628 * Used for configuring advanced_ddos_attack_l4_alert
629 */
630 megabits_per_second?: Array<string>;
631
632 /**
633 * Used for configuring load_balancing_health_alert
634 */
635 new_health?: Array<string>;
636
637 /**
638 * Used for configuring tunnel_health_event
639 */
640 new_status?: Array<string>;
641
642 /**
643 * Used for configuring advanced_ddos_attack_l4_alert
644 */
645 packets_per_second?: Array<string>;
646
647 /**
648 * Usage depends on specific alert type
649 */
650 pool_id?: Array<string>;
651
652 /**
653 * Used for configuring billing_usage_alert
654 */
655 product?: Array<string>;
656
657 /**
658 * Used for configuring pages_event_alert
659 */
660 project_id?: Array<string>;
661
662 /**
663 * Used for configuring advanced_ddos_attack_l4_alert
664 */
665 protocol?: Array<string>;
666
667 /**
668 * Usage depends on specific alert type
669 */
670 query_tag?: Array<string>;
671
672 /**
673 * Used for configuring advanced_ddos_attack_l7_alert
674 */
675 requests_per_second?: Array<string>;
676
677 /**
678 * Usage depends on specific alert type
679 */
680 selectors?: Array<string>;
681
682 /**
683 * Used for configuring clickhouse_alert_fw_ent_anomaly
684 */
685 services?: Array<string>;
686
687 /**
688 * Usage depends on specific alert type
689 */
690 slo?: Array<string>;
691
692 /**
693 * Used for configuring health_check_status_notification
694 */
695 status?: Array<string>;
696
697 /**
698 * Used for configuring advanced_ddos_attack_l7_alert
699 */
700 target_hostname?: Array<string>;
701
702 /**
703 * Used for configuring advanced_ddos_attack_l4_alert
704 */
705 target_ip?: Array<string>;
706
707 /**
708 * Used for configuring advanced_ddos_attack_l7_alert
709 */
710 target_zone_name?: Array<string>;
711
712 /**
713 * Used for configuring traffic_anomalies_alert
714 */
715 traffic_exclusions?: Array<'security_events'>;
716
717 /**
718 * Used for configuring tunnel_health_event
719 */
720 tunnel_id?: Array<string>;
721
722 /**
723 * Used for configuring magic_tunnel_health_check_event
724 */
725 tunnel_name?: Array<string>;
726
727 /**
728 * Usage depends on specific alert type
729 */
730 where?: Array<string>;
731
732 /**
733 * Usage depends on specific alert type
734 */
735 zones?: Array<string>;
736 }
737}
738
739export interface PolicyUpdateParams {
740 /**
741 * Path param: The account id
742 */
743 account_id: string;
744
745 /**
746 * Body param: Refers to which event will trigger a Notification dispatch. You can
747 * use the endpoint to get available alert types which then will give you a list of
748 * possible values.
749 */
750 alert_type?:
751 | 'access_custom_certificate_expiration_type'
752 | 'advanced_ddos_attack_l4_alert'
753 | 'advanced_ddos_attack_l7_alert'
754 | 'advanced_http_alert_error'
755 | 'bgp_hijack_notification'
756 | 'billing_usage_alert'
757 | 'block_notification_block_removed'
758 | 'block_notification_new_block'
759 | 'block_notification_review_rejected'
760 | 'brand_protection_alert'
761 | 'brand_protection_digest'
762 | 'clickhouse_alert_fw_anomaly'
763 | 'clickhouse_alert_fw_ent_anomaly'
764 | 'custom_ssl_certificate_event_type'
765 | 'dedicated_ssl_certificate_event_type'
766 | 'dos_attack_l4'
767 | 'dos_attack_l7'
768 | 'expiring_service_token_alert'
769 | 'failing_logpush_job_disabled_alert'
770 | 'fbm_auto_advertisement'
771 | 'fbm_dosd_attack'
772 | 'fbm_volumetric_attack'
773 | 'health_check_status_notification'
774 | 'hostname_aop_custom_certificate_expiration_type'
775 | 'http_alert_edge_error'
776 | 'http_alert_origin_error'
777 | 'incident_alert'
778 | 'load_balancing_health_alert'
779 | 'load_balancing_pool_enablement_alert'
780 | 'logo_match_alert'
781 | 'magic_tunnel_health_check_event'
782 | 'maintenance_event_notification'
783 | 'mtls_certificate_store_certificate_expiration_type'
784 | 'pages_event_alert'
785 | 'radar_notification'
786 | 'real_origin_monitoring'
787 | 'scriptmonitor_alert_new_code_change_detections'
788 | 'scriptmonitor_alert_new_hosts'
789 | 'scriptmonitor_alert_new_malicious_hosts'
790 | 'scriptmonitor_alert_new_malicious_scripts'
791 | 'scriptmonitor_alert_new_malicious_url'
792 | 'scriptmonitor_alert_new_max_length_resource_url'
793 | 'scriptmonitor_alert_new_resources'
794 | 'secondary_dns_all_primaries_failing'
795 | 'secondary_dns_primaries_failing'
796 | 'secondary_dns_zone_successfully_updated'
797 | 'secondary_dns_zone_validation_warning'
798 | 'sentinel_alert'
799 | 'stream_live_notifications'
800 | 'traffic_anomalies_alert'
801 | 'tunnel_health_event'
802 | 'tunnel_update_event'
803 | 'universal_ssl_event_type'
804 | 'web_analytics_metrics_update'
805 | 'zone_aop_custom_certificate_expiration_type';
806
807 /**
808 * Body param: Optional description for the Notification policy.
809 */
810 description?: string;
811
812 /**
813 * Body param: Whether or not the Notification policy is enabled.
814 */
815 enabled?: boolean;
816
817 /**
818 * Body param: Optional filters that allow you to be alerted only on a subset of
819 * events for that alert type based on some criteria. This is only available for
820 * select alert types. See alert type documentation for more details.
821 */
822 filters?: PolicyUpdateParams.Filters;
823
824 /**
825 * Body param: List of IDs that will be used when dispatching a notification. IDs
826 * for email type will be the email address.
827 */
828 mechanisms?: Record<string, Array<PolicyUpdateParams.Mechanisms>>;
829
830 /**
831 * Body param: Name of the policy.
832 */
833 name?: string;
834}
835
836export namespace PolicyUpdateParams {
837 /**
838 * Optional filters that allow you to be alerted only on a subset of events for
839 * that alert type based on some criteria. This is only available for select alert
840 * types. See alert type documentation for more details.
841 */
842 export interface Filters {
843 /**
844 * Usage depends on specific alert type
845 */
846 actions?: Array<string>;
847
848 /**
849 * Used for configuring radar_notification
850 */
851 affected_asns?: Array<string>;
852
853 /**
854 * Used for configuring incident_alert. A list of identifiers for each component to
855 * monitor.
856 */
857 affected_components?: Array<string>;
858
859 /**
860 * Used for configuring radar_notification
861 */
862 affected_locations?: Array<string>;
863
864 /**
865 * Used for configuring maintenance_event_notification
866 */
867 airport_code?: Array<string>;
868
869 /**
870 * Usage depends on specific alert type
871 */
872 alert_trigger_preferences?: Array<string>;
873
874 /**
875 * Used for configuring magic_tunnel_health_check_event
876 */
877 alert_trigger_preferences_value?: Array<'99.0' | '98.0' | '97.0'>;
878
879 /**
880 * Used for configuring load_balancing_pool_enablement_alert
881 */
882 enabled?: Array<string>;
883
884 /**
885 * Used for configuring pages_event_alert
886 */
887 environment?: Array<string>;
888
889 /**
890 * Used for configuring pages_event_alert
891 */
892 event?: Array<string>;
893
894 /**
895 * Used for configuring load_balancing_health_alert
896 */
897 event_source?: Array<string>;
898
899 /**
900 * Usage depends on specific alert type
901 */
902 event_type?: Array<string>;
903
904 /**
905 * Usage depends on specific alert type
906 */
907 group_by?: Array<string>;
908
909 /**
910 * Used for configuring health_check_status_notification
911 */
912 health_check_id?: Array<string>;
913
914 /**
915 * Used for configuring incident_alert
916 */
917 incident_impact?: Array<
918 'INCIDENT_IMPACT_NONE' | 'INCIDENT_IMPACT_MINOR' | 'INCIDENT_IMPACT_MAJOR' | 'INCIDENT_IMPACT_CRITICAL'
919 >;
920
921 /**
922 * Used for configuring stream_live_notifications
923 */
924 input_id?: Array<string>;
925
926 /**
927 * Used for configuring billing_usage_alert
928 */
929 limit?: Array<string>;
930
931 /**
932 * Used for configuring logo_match_alert
933 */
934 logo_tag?: Array<string>;
935
936 /**
937 * Used for configuring advanced_ddos_attack_l4_alert
938 */
939 megabits_per_second?: Array<string>;
940
941 /**
942 * Used for configuring load_balancing_health_alert
943 */
944 new_health?: Array<string>;
945
946 /**
947 * Used for configuring tunnel_health_event
948 */
949 new_status?: Array<string>;
950
951 /**
952 * Used for configuring advanced_ddos_attack_l4_alert
953 */
954 packets_per_second?: Array<string>;
955
956 /**
957 * Usage depends on specific alert type
958 */
959 pool_id?: Array<string>;
960
961 /**
962 * Used for configuring billing_usage_alert
963 */
964 product?: Array<string>;
965
966 /**
967 * Used for configuring pages_event_alert
968 */
969 project_id?: Array<string>;
970
971 /**
972 * Used for configuring advanced_ddos_attack_l4_alert
973 */
974 protocol?: Array<string>;
975
976 /**
977 * Usage depends on specific alert type
978 */
979 query_tag?: Array<string>;
980
981 /**
982 * Used for configuring advanced_ddos_attack_l7_alert
983 */
984 requests_per_second?: Array<string>;
985
986 /**
987 * Usage depends on specific alert type
988 */
989 selectors?: Array<string>;
990
991 /**
992 * Used for configuring clickhouse_alert_fw_ent_anomaly
993 */
994 services?: Array<string>;
995
996 /**
997 * Usage depends on specific alert type
998 */
999 slo?: Array<string>;
1000
1001 /**
1002 * Used for configuring health_check_status_notification
1003 */
1004 status?: Array<string>;
1005
1006 /**
1007 * Used for configuring advanced_ddos_attack_l7_alert
1008 */
1009 target_hostname?: Array<string>;
1010
1011 /**
1012 * Used for configuring advanced_ddos_attack_l4_alert
1013 */
1014 target_ip?: Array<string>;
1015
1016 /**
1017 * Used for configuring advanced_ddos_attack_l7_alert
1018 */
1019 target_zone_name?: Array<string>;
1020
1021 /**
1022 * Used for configuring traffic_anomalies_alert
1023 */
1024 traffic_exclusions?: Array<'security_events'>;
1025
1026 /**
1027 * Used for configuring tunnel_health_event
1028 */
1029 tunnel_id?: Array<string>;
1030
1031 /**
1032 * Used for configuring magic_tunnel_health_check_event
1033 */
1034 tunnel_name?: Array<string>;
1035
1036 /**
1037 * Usage depends on specific alert type
1038 */
1039 where?: Array<string>;
1040
1041 /**
1042 * Usage depends on specific alert type
1043 */
1044 zones?: Array<string>;
1045 }
1046
1047 export interface Mechanisms {
1048 /**
1049 * UUID
1050 */
1051 id?: string | string;
1052 }
1053}
1054
1055export interface PolicyListParams {
1056 /**
1057 * The account id
1058 */
1059 account_id: string;
1060}
1061
1062export interface PolicyDeleteParams {
1063 /**
1064 * The account id
1065 */
1066 account_id: string;
1067}
1068
1069export interface PolicyGetParams {
1070 /**
1071 * The account id
1072 */
1073 account_id: string;
1074}
1075
1076export namespace Policies {
1077 export import AaaPolicies = PoliciesAPI.AaaPolicies;
1078 export import PolicyCreateResponse = PoliciesAPI.PolicyCreateResponse;
1079 export import PolicyUpdateResponse = PoliciesAPI.PolicyUpdateResponse;
1080 export import PolicyListResponse = PoliciesAPI.PolicyListResponse;
1081 export import PolicyDeleteResponse = PoliciesAPI.PolicyDeleteResponse;
1082 export import PolicyCreateParams = PoliciesAPI.PolicyCreateParams;
1083 export import PolicyUpdateParams = PoliciesAPI.PolicyUpdateParams;
1084 export import PolicyListParams = PoliciesAPI.PolicyListParams;
1085 export import PolicyDeleteParams = PoliciesAPI.PolicyDeleteParams;
1086 export import PolicyGetParams = PoliciesAPI.PolicyGetParams;
1087}
1088