watchfor 0.1.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -1
- package/dist/cli.js +17 -1
- package/dist/client.d.ts +24 -1
- package/dist/client.js +30 -0
- package/dist/schema.d.ts +760 -219
- package/package.json +4 -3
package/dist/schema.d.ts
CHANGED
|
@@ -55,6 +55,26 @@ export interface paths {
|
|
|
55
55
|
patch?: never;
|
|
56
56
|
trace?: never;
|
|
57
57
|
};
|
|
58
|
+
"/batch": {
|
|
59
|
+
parameters: {
|
|
60
|
+
query?: never;
|
|
61
|
+
header?: never;
|
|
62
|
+
path?: never;
|
|
63
|
+
cookie?: never;
|
|
64
|
+
};
|
|
65
|
+
get?: never;
|
|
66
|
+
put?: never;
|
|
67
|
+
/**
|
|
68
|
+
* Run up to 20 API operations in one request
|
|
69
|
+
* @description Execute an array of operations in a single round trip. Each runs against /api/v1 with the same credential, so scopes, validation and rate limits apply per sub-operation. Returns a parallel array of {status, body}.
|
|
70
|
+
*/
|
|
71
|
+
post: operations["batchOperations"];
|
|
72
|
+
delete?: never;
|
|
73
|
+
options?: never;
|
|
74
|
+
head?: never;
|
|
75
|
+
patch?: never;
|
|
76
|
+
trace?: never;
|
|
77
|
+
};
|
|
58
78
|
"/monitors": {
|
|
59
79
|
parameters: {
|
|
60
80
|
query?: never;
|
|
@@ -94,10 +114,7 @@ export interface paths {
|
|
|
94
114
|
parameters: {
|
|
95
115
|
query?: never;
|
|
96
116
|
header?: never;
|
|
97
|
-
path
|
|
98
|
-
/** @description Resource id (UUID) */
|
|
99
|
-
id: string;
|
|
100
|
-
};
|
|
117
|
+
path?: never;
|
|
101
118
|
cookie?: never;
|
|
102
119
|
};
|
|
103
120
|
/** Get a monitor */
|
|
@@ -116,10 +133,7 @@ export interface paths {
|
|
|
116
133
|
parameters: {
|
|
117
134
|
query?: never;
|
|
118
135
|
header?: never;
|
|
119
|
-
path
|
|
120
|
-
/** @description Resource id (UUID) */
|
|
121
|
-
id: string;
|
|
122
|
-
};
|
|
136
|
+
path?: never;
|
|
123
137
|
cookie?: never;
|
|
124
138
|
};
|
|
125
139
|
get?: never;
|
|
@@ -136,10 +150,7 @@ export interface paths {
|
|
|
136
150
|
parameters: {
|
|
137
151
|
query?: never;
|
|
138
152
|
header?: never;
|
|
139
|
-
path
|
|
140
|
-
/** @description Resource id (UUID) */
|
|
141
|
-
id: string;
|
|
142
|
-
};
|
|
153
|
+
path?: never;
|
|
143
154
|
cookie?: never;
|
|
144
155
|
};
|
|
145
156
|
get?: never;
|
|
@@ -156,10 +167,7 @@ export interface paths {
|
|
|
156
167
|
parameters: {
|
|
157
168
|
query?: never;
|
|
158
169
|
header?: never;
|
|
159
|
-
path
|
|
160
|
-
/** @description Resource id (UUID) */
|
|
161
|
-
id: string;
|
|
162
|
-
};
|
|
170
|
+
path?: never;
|
|
163
171
|
cookie?: never;
|
|
164
172
|
};
|
|
165
173
|
get?: never;
|
|
@@ -174,17 +182,12 @@ export interface paths {
|
|
|
174
182
|
};
|
|
175
183
|
"/monitors/{id}/uptime": {
|
|
176
184
|
parameters: {
|
|
177
|
-
query?:
|
|
178
|
-
period?: "1h" | "24h" | "7d" | "30d" | "90d";
|
|
179
|
-
};
|
|
185
|
+
query?: never;
|
|
180
186
|
header?: never;
|
|
181
|
-
path
|
|
182
|
-
/** @description Resource id (UUID) */
|
|
183
|
-
id: string;
|
|
184
|
-
};
|
|
187
|
+
path?: never;
|
|
185
188
|
cookie?: never;
|
|
186
189
|
};
|
|
187
|
-
/** Uptime
|
|
190
|
+
/** Uptime (confirmed critical incidents only), check success and response-time stats (maintenance excluded) */
|
|
188
191
|
get: operations["getMonitorUptime"];
|
|
189
192
|
put?: never;
|
|
190
193
|
post?: never;
|
|
@@ -196,15 +199,9 @@ export interface paths {
|
|
|
196
199
|
};
|
|
197
200
|
"/monitors/{id}/checks": {
|
|
198
201
|
parameters: {
|
|
199
|
-
query?:
|
|
200
|
-
hours?: number;
|
|
201
|
-
limit?: number;
|
|
202
|
-
};
|
|
202
|
+
query?: never;
|
|
203
203
|
header?: never;
|
|
204
|
-
path
|
|
205
|
-
/** @description Resource id (UUID) */
|
|
206
|
-
id: string;
|
|
207
|
-
};
|
|
204
|
+
path?: never;
|
|
208
205
|
cookie?: never;
|
|
209
206
|
};
|
|
210
207
|
/** Raw check history + per-location breakdown */
|
|
@@ -221,10 +218,7 @@ export interface paths {
|
|
|
221
218
|
parameters: {
|
|
222
219
|
query?: never;
|
|
223
220
|
header?: never;
|
|
224
|
-
path
|
|
225
|
-
/** @description Resource id (UUID) */
|
|
226
|
-
id: string;
|
|
227
|
-
};
|
|
221
|
+
path?: never;
|
|
228
222
|
cookie?: never;
|
|
229
223
|
};
|
|
230
224
|
/** List a monitor's alert rules */
|
|
@@ -242,19 +236,14 @@ export interface paths {
|
|
|
242
236
|
parameters: {
|
|
243
237
|
query?: never;
|
|
244
238
|
header?: never;
|
|
245
|
-
path
|
|
246
|
-
/** @description Resource id (UUID) */
|
|
247
|
-
id: string;
|
|
248
|
-
/** @description Resource id (UUID) */
|
|
249
|
-
ruleId: string;
|
|
250
|
-
};
|
|
239
|
+
path?: never;
|
|
251
240
|
cookie?: never;
|
|
252
241
|
};
|
|
253
242
|
/** Get an alert rule */
|
|
254
243
|
get: operations["getAlertRule"];
|
|
255
244
|
put?: never;
|
|
256
245
|
post?: never;
|
|
257
|
-
/** Delete an alert rule (system rules →
|
|
246
|
+
/** Delete an alert rule (system rules → 403) */
|
|
258
247
|
delete: operations["deleteAlertRule"];
|
|
259
248
|
options?: never;
|
|
260
249
|
head?: never;
|
|
@@ -300,10 +289,7 @@ export interface paths {
|
|
|
300
289
|
parameters: {
|
|
301
290
|
query?: never;
|
|
302
291
|
header?: never;
|
|
303
|
-
path
|
|
304
|
-
/** @description Incident id (integer) */
|
|
305
|
-
id: string;
|
|
306
|
-
};
|
|
292
|
+
path?: never;
|
|
307
293
|
cookie?: never;
|
|
308
294
|
};
|
|
309
295
|
/** Get an incident */
|
|
@@ -320,10 +306,7 @@ export interface paths {
|
|
|
320
306
|
parameters: {
|
|
321
307
|
query?: never;
|
|
322
308
|
header?: never;
|
|
323
|
-
path
|
|
324
|
-
/** @description Incident id (integer) */
|
|
325
|
-
id: string;
|
|
326
|
-
};
|
|
309
|
+
path?: never;
|
|
327
310
|
cookie?: never;
|
|
328
311
|
};
|
|
329
312
|
get?: never;
|
|
@@ -340,10 +323,7 @@ export interface paths {
|
|
|
340
323
|
parameters: {
|
|
341
324
|
query?: never;
|
|
342
325
|
header?: never;
|
|
343
|
-
path
|
|
344
|
-
/** @description Incident id (integer) */
|
|
345
|
-
id: string;
|
|
346
|
-
};
|
|
326
|
+
path?: never;
|
|
347
327
|
cookie?: never;
|
|
348
328
|
};
|
|
349
329
|
get?: never;
|
|
@@ -360,10 +340,7 @@ export interface paths {
|
|
|
360
340
|
parameters: {
|
|
361
341
|
query?: never;
|
|
362
342
|
header?: never;
|
|
363
|
-
path
|
|
364
|
-
/** @description Incident id (integer) */
|
|
365
|
-
id: string;
|
|
366
|
-
};
|
|
343
|
+
path?: never;
|
|
367
344
|
cookie?: never;
|
|
368
345
|
};
|
|
369
346
|
get?: never;
|
|
@@ -398,10 +375,7 @@ export interface paths {
|
|
|
398
375
|
parameters: {
|
|
399
376
|
query?: never;
|
|
400
377
|
header?: never;
|
|
401
|
-
path
|
|
402
|
-
/** @description Resource id (UUID) */
|
|
403
|
-
id: string;
|
|
404
|
-
};
|
|
378
|
+
path?: never;
|
|
405
379
|
cookie?: never;
|
|
406
380
|
};
|
|
407
381
|
/** Get a window */
|
|
@@ -438,10 +412,7 @@ export interface paths {
|
|
|
438
412
|
parameters: {
|
|
439
413
|
query?: never;
|
|
440
414
|
header?: never;
|
|
441
|
-
path
|
|
442
|
-
/** @description Resource id (UUID) */
|
|
443
|
-
id: string;
|
|
444
|
-
};
|
|
415
|
+
path?: never;
|
|
445
416
|
cookie?: never;
|
|
446
417
|
};
|
|
447
418
|
/** Get a contact */
|
|
@@ -478,10 +449,7 @@ export interface paths {
|
|
|
478
449
|
parameters: {
|
|
479
450
|
query?: never;
|
|
480
451
|
header?: never;
|
|
481
|
-
path
|
|
482
|
-
/** @description Resource id (UUID) */
|
|
483
|
-
id: string;
|
|
484
|
-
};
|
|
452
|
+
path?: never;
|
|
485
453
|
cookie?: never;
|
|
486
454
|
};
|
|
487
455
|
/** Get a group (with members) */
|
|
@@ -518,10 +486,7 @@ export interface paths {
|
|
|
518
486
|
parameters: {
|
|
519
487
|
query?: never;
|
|
520
488
|
header?: never;
|
|
521
|
-
path
|
|
522
|
-
/** @description Resource id (UUID) */
|
|
523
|
-
id: string;
|
|
524
|
-
};
|
|
489
|
+
path?: never;
|
|
525
490
|
cookie?: never;
|
|
526
491
|
};
|
|
527
492
|
/** Get a page (with components) */
|
|
@@ -540,10 +505,7 @@ export interface paths {
|
|
|
540
505
|
parameters: {
|
|
541
506
|
query?: never;
|
|
542
507
|
header?: never;
|
|
543
|
-
path
|
|
544
|
-
/** @description Resource id (UUID) */
|
|
545
|
-
id: string;
|
|
546
|
-
};
|
|
508
|
+
path?: never;
|
|
547
509
|
cookie?: never;
|
|
548
510
|
};
|
|
549
511
|
/** List announcements */
|
|
@@ -561,12 +523,7 @@ export interface paths {
|
|
|
561
523
|
parameters: {
|
|
562
524
|
query?: never;
|
|
563
525
|
header?: never;
|
|
564
|
-
path
|
|
565
|
-
/** @description Resource id (UUID) */
|
|
566
|
-
id: string;
|
|
567
|
-
/** @description Resource id (UUID) */
|
|
568
|
-
announcementId: string;
|
|
569
|
-
};
|
|
526
|
+
path?: never;
|
|
570
527
|
cookie?: never;
|
|
571
528
|
};
|
|
572
529
|
/** Get an announcement */
|
|
@@ -683,6 +640,57 @@ export interface paths {
|
|
|
683
640
|
patch?: never;
|
|
684
641
|
trace?: never;
|
|
685
642
|
};
|
|
643
|
+
"/reports": {
|
|
644
|
+
parameters: {
|
|
645
|
+
query?: never;
|
|
646
|
+
header?: never;
|
|
647
|
+
path?: never;
|
|
648
|
+
cookie?: never;
|
|
649
|
+
};
|
|
650
|
+
/** Org report for a period vs the previous one: uptime, incidents, MTTR/MTBF, response time, per-monitor rows, type-aware sections (SSL/domain expiry, Core Web Vitals, heartbeats, blocklists, MCP drift) and plain-language insights */
|
|
651
|
+
get: operations["getReport"];
|
|
652
|
+
put?: never;
|
|
653
|
+
post?: never;
|
|
654
|
+
delete?: never;
|
|
655
|
+
options?: never;
|
|
656
|
+
head?: never;
|
|
657
|
+
patch?: never;
|
|
658
|
+
trace?: never;
|
|
659
|
+
};
|
|
660
|
+
"/reports/schedules": {
|
|
661
|
+
parameters: {
|
|
662
|
+
query?: never;
|
|
663
|
+
header?: never;
|
|
664
|
+
path?: never;
|
|
665
|
+
cookie?: never;
|
|
666
|
+
};
|
|
667
|
+
/** The organization's two report-email cadences (weekly + monthly) with their recipients and enabled state */
|
|
668
|
+
get: operations["listReportSchedules"];
|
|
669
|
+
put?: never;
|
|
670
|
+
post?: never;
|
|
671
|
+
delete?: never;
|
|
672
|
+
options?: never;
|
|
673
|
+
head?: never;
|
|
674
|
+
patch?: never;
|
|
675
|
+
trace?: never;
|
|
676
|
+
};
|
|
677
|
+
"/reports/schedules/{frequency}": {
|
|
678
|
+
parameters: {
|
|
679
|
+
query?: never;
|
|
680
|
+
header?: never;
|
|
681
|
+
path?: never;
|
|
682
|
+
cookie?: never;
|
|
683
|
+
};
|
|
684
|
+
get?: never;
|
|
685
|
+
put?: never;
|
|
686
|
+
post?: never;
|
|
687
|
+
delete?: never;
|
|
688
|
+
options?: never;
|
|
689
|
+
head?: never;
|
|
690
|
+
/** Enable/disable the weekly or monthly report email and/or set its recipients (up to 5). Enabling needs at least one recipient; clearing the list disables the cadence; adding the first recipient to an empty, disabled cadence enables it automatically. */
|
|
691
|
+
patch: operations["updateReportSchedule"];
|
|
692
|
+
trace?: never;
|
|
693
|
+
};
|
|
686
694
|
}
|
|
687
695
|
export type webhooks = Record<string, never>;
|
|
688
696
|
export interface components {
|
|
@@ -714,8 +722,11 @@ export interface components {
|
|
|
714
722
|
target?: string;
|
|
715
723
|
description?: string | null;
|
|
716
724
|
interval_seconds?: number;
|
|
717
|
-
/**
|
|
718
|
-
|
|
725
|
+
/**
|
|
726
|
+
* @description Effective status. down = a confirmed critical incident is open (firing or acknowledged); degraded = a failed check not yet confirmed, or an open warning incident; unknown = no check data yet. paused always wins.
|
|
727
|
+
* @enum {string}
|
|
728
|
+
*/
|
|
729
|
+
status?: "up" | "degraded" | "down" | "paused" | "unknown";
|
|
719
730
|
active?: boolean;
|
|
720
731
|
/** @enum {string} */
|
|
721
732
|
scheduling_strategy?: "roundrobin" | "random" | "parallel";
|
|
@@ -730,17 +741,19 @@ export interface components {
|
|
|
730
741
|
};
|
|
731
742
|
MonitorCreate: {
|
|
732
743
|
name: string;
|
|
744
|
+
/** @description http, api, dns, tcp, ssl, udp, icmp, mtr, smtp, ftp, sftp, websocket, rdap, blacklist, ntp, email_policy, sitemap, favicon, cdn, breach, brotli, cms, browser, heartbeat, mcp */
|
|
733
745
|
type: string;
|
|
734
746
|
target: string;
|
|
735
|
-
/** @description Seconds */
|
|
747
|
+
/** @description Seconds; validated against the plan's per-type minimum */
|
|
736
748
|
interval: number;
|
|
737
|
-
/** @description Location ids from GET /locations; required except for heartbeat */
|
|
749
|
+
/** @description Location ids from GET /locations; at least one is required except for heartbeat (which takes none) */
|
|
738
750
|
locations?: string[];
|
|
739
751
|
/**
|
|
740
752
|
* @default roundrobin
|
|
741
753
|
* @enum {string}
|
|
742
754
|
*/
|
|
743
755
|
schedulingStrategy: "roundrobin" | "random" | "parallel";
|
|
756
|
+
/** @description Lowercase alphanumeric with hyphens or colons, e.g. prod, team:web */
|
|
744
757
|
tags?: string[];
|
|
745
758
|
description?: string;
|
|
746
759
|
config?: Record<string, never>;
|
|
@@ -752,7 +765,8 @@ export interface components {
|
|
|
752
765
|
target?: string;
|
|
753
766
|
description?: string;
|
|
754
767
|
interval?: number;
|
|
755
|
-
|
|
768
|
+
/** @enum {string} */
|
|
769
|
+
schedulingStrategy?: "roundrobin" | "random" | "parallel";
|
|
756
770
|
locations?: string[];
|
|
757
771
|
tags?: string[];
|
|
758
772
|
config?: Record<string, never>;
|
|
@@ -764,7 +778,12 @@ export interface components {
|
|
|
764
778
|
monitor_id?: string;
|
|
765
779
|
/** @enum {string} */
|
|
766
780
|
period?: "1h" | "24h" | "7d" | "30d" | "90d";
|
|
781
|
+
/** @description Incident-based uptime: 100 − share of the period inside confirmed critical incidents; scheduled maintenance is neutral and the window is clamped to the monitor's creation time. Failed checks that never became a confirmed incident do not reduce it. null only before the monitor existed. */
|
|
767
782
|
uptime_percent?: number | null;
|
|
783
|
+
/** @description Milliseconds inside confirmed critical incidents this period, maintenance excluded */
|
|
784
|
+
downtime_ms?: number;
|
|
785
|
+
/** @description Successful ÷ total checks over the period (maintenance excluded); null when the period has no checks */
|
|
786
|
+
check_success_percent?: number | null;
|
|
768
787
|
total_checks?: number;
|
|
769
788
|
successful_checks?: number;
|
|
770
789
|
failed_checks?: number;
|
|
@@ -772,6 +791,7 @@ export interface components {
|
|
|
772
791
|
min_response_time_ms?: number | null;
|
|
773
792
|
max_response_time_ms?: number | null;
|
|
774
793
|
last_failure_at?: string | null;
|
|
794
|
+
/** @description Incident-based headline uptime for the last 24 hours */
|
|
775
795
|
uptime_24h?: number | null;
|
|
776
796
|
uptime_7d?: number | null;
|
|
777
797
|
uptime_30d?: number | null;
|
|
@@ -806,7 +826,7 @@ export interface components {
|
|
|
806
826
|
operator?: string;
|
|
807
827
|
value?: string;
|
|
808
828
|
/** @enum {string} */
|
|
809
|
-
severity?: "critical" | "warning"
|
|
829
|
+
severity?: "critical" | "warning";
|
|
810
830
|
failure_threshold?: number;
|
|
811
831
|
min_failed_probes?: number;
|
|
812
832
|
duration_window_seconds?: number;
|
|
@@ -830,7 +850,7 @@ export interface components {
|
|
|
830
850
|
* @default critical
|
|
831
851
|
* @enum {string}
|
|
832
852
|
*/
|
|
833
|
-
severity: "critical" | "warning"
|
|
853
|
+
severity: "critical" | "warning";
|
|
834
854
|
/** @default 1 */
|
|
835
855
|
failureThreshold: number;
|
|
836
856
|
/** @default 1 */
|
|
@@ -862,7 +882,15 @@ export interface components {
|
|
|
862
882
|
status?: "firing" | "acknowledged" | "resolved";
|
|
863
883
|
/** @enum {string} */
|
|
864
884
|
severity?: "warning" | "critical";
|
|
885
|
+
/** @description Human-readable explanation of what failed, derived from the rule that fired (e.g. 'Received an unexpected HTTP status code (expected: 2xx, 3xx)'); the raw engine message only when no rule snapshot exists */
|
|
865
886
|
message?: string;
|
|
887
|
+
/** @description Fire-time alert-rule snapshot — frozen when the incident opened, so later edits to the rule do not rewrite history. null only for old incidents without a snapshot. */
|
|
888
|
+
rule?: {
|
|
889
|
+
name?: string;
|
|
890
|
+
metric?: string;
|
|
891
|
+
operator?: string;
|
|
892
|
+
value?: string;
|
|
893
|
+
} | null;
|
|
866
894
|
monitor?: {
|
|
867
895
|
/** Format: uuid */
|
|
868
896
|
id?: string;
|
|
@@ -872,6 +900,8 @@ export interface components {
|
|
|
872
900
|
started_at?: string;
|
|
873
901
|
acknowledged_at?: string | null;
|
|
874
902
|
resolved_at?: string | null;
|
|
903
|
+
/** @description started_at → resolved_at in seconds; null while open */
|
|
904
|
+
duration_seconds?: number | null;
|
|
875
905
|
};
|
|
876
906
|
MaintenanceWindow: {
|
|
877
907
|
/** Format: uuid */
|
|
@@ -895,28 +925,159 @@ export interface components {
|
|
|
895
925
|
/** Format: date-time */
|
|
896
926
|
created_at?: string;
|
|
897
927
|
};
|
|
928
|
+
/** @description At least one of monitorIds / monitorTags is required. Status-page publishing (statusPageIds, autoPublish) is dashboard-only — sending either field returns 400 invalid_request. */
|
|
898
929
|
MaintenanceWindowCreate: {
|
|
899
930
|
name: string;
|
|
900
931
|
/** Format: date-time */
|
|
901
932
|
startsAt: string;
|
|
933
|
+
/** @description 5 minutes to 30 days */
|
|
902
934
|
durationMinutes: number;
|
|
935
|
+
/** @description Ids outside your organization are dropped, not rejected */
|
|
903
936
|
monitorIds?: string[];
|
|
937
|
+
/** @description Tag targeting also covers monitors that get the tag later; unions with monitorIds */
|
|
904
938
|
monitorTags?: string[];
|
|
905
939
|
description?: string;
|
|
906
|
-
/**
|
|
940
|
+
/**
|
|
941
|
+
* @description IANA name used to interpret recurring start times
|
|
942
|
+
* @default UTC
|
|
943
|
+
*/
|
|
907
944
|
timezone: string;
|
|
908
945
|
/**
|
|
909
946
|
* @default once
|
|
910
947
|
* @enum {string}
|
|
911
948
|
*/
|
|
912
949
|
recurrence: "once" | "daily" | "weekly" | "monthly";
|
|
913
|
-
/**
|
|
950
|
+
/**
|
|
951
|
+
* Format: date-time
|
|
952
|
+
* @description Must be after startsAt
|
|
953
|
+
*/
|
|
914
954
|
recurrenceUntil?: string;
|
|
915
955
|
/** @default true */
|
|
916
956
|
suppressAlerts: boolean;
|
|
917
|
-
/**
|
|
957
|
+
/**
|
|
958
|
+
* @description Show the Maintenance badge on covered monitors while active
|
|
959
|
+
* @default true
|
|
960
|
+
*/
|
|
961
|
+
markMaintenance: boolean;
|
|
962
|
+
/**
|
|
963
|
+
* @description Exclude the window's time from uptime/SLA
|
|
964
|
+
* @default true
|
|
965
|
+
*/
|
|
918
966
|
excludeFromSla: boolean;
|
|
919
967
|
};
|
|
968
|
+
/** @description Partial update. timezone and recurrence cannot be changed after creation — delete and recreate the window instead. */
|
|
969
|
+
MaintenanceWindowUpdate: {
|
|
970
|
+
name?: string;
|
|
971
|
+
description?: string | null;
|
|
972
|
+
/** Format: date-time */
|
|
973
|
+
startsAt?: string;
|
|
974
|
+
durationMinutes?: number;
|
|
975
|
+
monitorIds?: string[];
|
|
976
|
+
monitorTags?: string[];
|
|
977
|
+
suppressAlerts?: boolean;
|
|
978
|
+
excludeFromSla?: boolean;
|
|
979
|
+
/** @description false disables the window without deleting it (no further occurrences activate) */
|
|
980
|
+
enabled?: boolean;
|
|
981
|
+
};
|
|
982
|
+
AlertRuleUpdate: {
|
|
983
|
+
name?: string;
|
|
984
|
+
metric?: string;
|
|
985
|
+
operator?: string;
|
|
986
|
+
value?: string;
|
|
987
|
+
/** @enum {string} */
|
|
988
|
+
severity?: "critical" | "warning";
|
|
989
|
+
failureThreshold?: number;
|
|
990
|
+
minFailedProbes?: number;
|
|
991
|
+
/** @description Seconds */
|
|
992
|
+
durationWindow?: number;
|
|
993
|
+
enabled?: boolean;
|
|
994
|
+
};
|
|
995
|
+
ContactUpdate: {
|
|
996
|
+
name?: string;
|
|
997
|
+
/** Format: email */
|
|
998
|
+
email?: string;
|
|
999
|
+
phone?: string | null;
|
|
1000
|
+
groupIds?: string[];
|
|
1001
|
+
};
|
|
1002
|
+
ContactGroupCreate: {
|
|
1003
|
+
name: string;
|
|
1004
|
+
contactIds?: string[];
|
|
1005
|
+
};
|
|
1006
|
+
ContactGroupUpdate: {
|
|
1007
|
+
name?: string;
|
|
1008
|
+
contactIds?: string[];
|
|
1009
|
+
};
|
|
1010
|
+
/** @description Password protection, logo upload and custom subdomains are dashboard-only. */
|
|
1011
|
+
StatusPageCreate: {
|
|
1012
|
+
/** @description Lowercase letters, numbers and dashes; globally unique across WatchFor (409 when taken) */
|
|
1013
|
+
slug: string;
|
|
1014
|
+
name: string;
|
|
1015
|
+
description?: string;
|
|
1016
|
+
/** @default true */
|
|
1017
|
+
isPublic: boolean;
|
|
1018
|
+
/**
|
|
1019
|
+
* @description Confirmed incidents on component monitors appear on the page automatically
|
|
1020
|
+
* @default true
|
|
1021
|
+
*/
|
|
1022
|
+
autoPublishIncidents: boolean;
|
|
1023
|
+
/** @default false */
|
|
1024
|
+
dimUntrackedDays: boolean;
|
|
1025
|
+
/**
|
|
1026
|
+
* @default auto
|
|
1027
|
+
* @enum {string}
|
|
1028
|
+
*/
|
|
1029
|
+
theme: "light" | "dark" | "auto";
|
|
1030
|
+
/**
|
|
1031
|
+
* @description Components in display order (position = array index); monitor ids outside your organization are dropped, not rejected
|
|
1032
|
+
* @default []
|
|
1033
|
+
*/
|
|
1034
|
+
components: {
|
|
1035
|
+
name: string;
|
|
1036
|
+
description?: string;
|
|
1037
|
+
/** @default [] */
|
|
1038
|
+
monitorIds: string[];
|
|
1039
|
+
/** @default [] */
|
|
1040
|
+
monitorTags: string[];
|
|
1041
|
+
}[];
|
|
1042
|
+
};
|
|
1043
|
+
/** @description Partial update. Component editing, password protection and logo upload are dashboard-only. A slug change re-checks uniqueness (409) and the old URL stops serving immediately. */
|
|
1044
|
+
StatusPageUpdate: {
|
|
1045
|
+
slug?: string;
|
|
1046
|
+
name?: string;
|
|
1047
|
+
description?: string | null;
|
|
1048
|
+
isPublic?: boolean;
|
|
1049
|
+
autoPublishIncidents?: boolean;
|
|
1050
|
+
dimUntrackedDays?: boolean;
|
|
1051
|
+
/** @enum {string} */
|
|
1052
|
+
theme?: "light" | "dark" | "auto";
|
|
1053
|
+
};
|
|
1054
|
+
/** @description Manual incident notice on the page (type is always incident; maintenance notices come from maintenance windows). */
|
|
1055
|
+
AnnouncementCreate: {
|
|
1056
|
+
title: string;
|
|
1057
|
+
/** @description Becomes the first timeline entry */
|
|
1058
|
+
body: string;
|
|
1059
|
+
/**
|
|
1060
|
+
* @default investigating
|
|
1061
|
+
* @enum {string}
|
|
1062
|
+
*/
|
|
1063
|
+
status: "investigating" | "identified" | "monitoring" | "resolved";
|
|
1064
|
+
/**
|
|
1065
|
+
* @default minor
|
|
1066
|
+
* @enum {string}
|
|
1067
|
+
*/
|
|
1068
|
+
severity: "minor" | "major" | "critical";
|
|
1069
|
+
/**
|
|
1070
|
+
* @description Component ids of this page; any other id returns 400
|
|
1071
|
+
* @default []
|
|
1072
|
+
*/
|
|
1073
|
+
affectedComponentIds: string[];
|
|
1074
|
+
};
|
|
1075
|
+
/** @description PATCH = post an update: appends an entry to the public timeline and moves the announcement to `status`; resolved closes it and sets resolved_at. Title and severity edits are dashboard-only. */
|
|
1076
|
+
AnnouncementUpdate: {
|
|
1077
|
+
body: string;
|
|
1078
|
+
/** @enum {string} */
|
|
1079
|
+
status: "investigating" | "identified" | "monitoring" | "resolved";
|
|
1080
|
+
};
|
|
920
1081
|
Contact: {
|
|
921
1082
|
/** Format: uuid */
|
|
922
1083
|
id?: string;
|
|
@@ -1054,13 +1215,79 @@ export interface components {
|
|
|
1054
1215
|
/** Format: date-time */
|
|
1055
1216
|
created_at?: string;
|
|
1056
1217
|
};
|
|
1218
|
+
Ack: {
|
|
1219
|
+
object?: string;
|
|
1220
|
+
ok?: boolean;
|
|
1221
|
+
status?: string;
|
|
1222
|
+
message?: string;
|
|
1223
|
+
};
|
|
1224
|
+
/** @description Deletion confirmation (Stripe semantics): echoes the removed resource's id. */
|
|
1225
|
+
Deleted: {
|
|
1226
|
+
/** @constant */
|
|
1227
|
+
object: "deleted";
|
|
1228
|
+
id: string;
|
|
1229
|
+
/** @constant */
|
|
1230
|
+
deleted: true;
|
|
1231
|
+
};
|
|
1232
|
+
/** @description An OpenAPI 3.1 document describing this API. */
|
|
1233
|
+
OpenApiDocument: {
|
|
1234
|
+
openapi: string;
|
|
1235
|
+
info: Record<string, never>;
|
|
1236
|
+
paths: Record<string, never>;
|
|
1237
|
+
components?: Record<string, never>;
|
|
1238
|
+
};
|
|
1239
|
+
BatchResult: {
|
|
1240
|
+
/** @constant */
|
|
1241
|
+
object: "batch_result";
|
|
1242
|
+
results: {
|
|
1243
|
+
status: number;
|
|
1244
|
+
body?: Record<string, never>;
|
|
1245
|
+
}[];
|
|
1246
|
+
};
|
|
1247
|
+
Me: {
|
|
1248
|
+
/** @constant */
|
|
1249
|
+
object?: "api_key_identity";
|
|
1250
|
+
organization?: {
|
|
1251
|
+
/** Format: uuid */
|
|
1252
|
+
id?: string;
|
|
1253
|
+
name?: string;
|
|
1254
|
+
slug?: string;
|
|
1255
|
+
} | null;
|
|
1256
|
+
/** @enum {string} */
|
|
1257
|
+
scope?: "read" | "write";
|
|
1258
|
+
};
|
|
1259
|
+
MonitorType: {
|
|
1260
|
+
/** @constant */
|
|
1261
|
+
object?: "monitor_type";
|
|
1262
|
+
type?: string;
|
|
1263
|
+
label?: string;
|
|
1264
|
+
target_format?: string;
|
|
1265
|
+
target_example?: string;
|
|
1266
|
+
alert_metrics?: Record<string, never>[];
|
|
1267
|
+
config_fields?: Record<string, never>[];
|
|
1268
|
+
default_alert_rules?: Record<string, never>[];
|
|
1269
|
+
};
|
|
1057
1270
|
Summary: {
|
|
1058
1271
|
/** @constant */
|
|
1059
1272
|
object?: "summary";
|
|
1060
|
-
/** @description
|
|
1061
|
-
monitors?:
|
|
1062
|
-
|
|
1063
|
-
|
|
1273
|
+
/** @description Effective-status counts — same rule as the dashboard: an open critical incident flips a stale up/unknown to down; an open warning incident or an unconfirmed failed check counts as degraded; paused always wins. health_score is 0-100 (share of active, non-paused monitors that are up). */
|
|
1274
|
+
monitors?: {
|
|
1275
|
+
total?: number;
|
|
1276
|
+
up?: number;
|
|
1277
|
+
degraded?: number;
|
|
1278
|
+
down?: number;
|
|
1279
|
+
paused?: number;
|
|
1280
|
+
unknown?: number;
|
|
1281
|
+
health_score?: number;
|
|
1282
|
+
};
|
|
1283
|
+
/** @description Open incident counts (firing, split by severity, and acknowledged) plus incidents started in the last 24h */
|
|
1284
|
+
incidents?: {
|
|
1285
|
+
firing?: number;
|
|
1286
|
+
firing_critical?: number;
|
|
1287
|
+
firing_warning?: number;
|
|
1288
|
+
acknowledged?: number;
|
|
1289
|
+
started_24h?: number;
|
|
1290
|
+
};
|
|
1064
1291
|
open_maintenance_windows?: number;
|
|
1065
1292
|
};
|
|
1066
1293
|
IncidentStats: {
|
|
@@ -1079,6 +1306,74 @@ export interface components {
|
|
|
1079
1306
|
counts?: Record<string, never>[];
|
|
1080
1307
|
top_unstable_monitors?: Record<string, never>[];
|
|
1081
1308
|
};
|
|
1309
|
+
/** @description Scheduled report-email cadence (weekly or monthly). Every organization has exactly these two; recipients are capped at 5. suppressed_recipients lists addresses that unsubscribed themselves — kept on the list but skipped at send time. */
|
|
1310
|
+
ReportSchedule: {
|
|
1311
|
+
/** @constant */
|
|
1312
|
+
object?: "report_schedule";
|
|
1313
|
+
/** @enum {string} */
|
|
1314
|
+
frequency?: "weekly" | "monthly";
|
|
1315
|
+
enabled?: boolean;
|
|
1316
|
+
recipients?: string[];
|
|
1317
|
+
suppressed_recipients?: string[];
|
|
1318
|
+
};
|
|
1319
|
+
/** @description Org report for a period, always compared with the equal-length previous period. Compared values carry {current, previous, delta}; previous/delta are null with no baseline. Depth follows the plan: basic omits the type-aware sections (listed in gatedSections), withholds insights beyond a cap (gatedInsightCount) and truncates the monitors table. Field names are camelCase (the dashboard's report document), unlike the rest of the API. */
|
|
1320
|
+
Report: {
|
|
1321
|
+
/** @constant */
|
|
1322
|
+
object?: "report";
|
|
1323
|
+
meta?: {
|
|
1324
|
+
organizationId?: string;
|
|
1325
|
+
organizationName?: string;
|
|
1326
|
+
generatedAtMs?: number;
|
|
1327
|
+
period?: {
|
|
1328
|
+
fromMs?: number;
|
|
1329
|
+
toMs?: number;
|
|
1330
|
+
label?: string;
|
|
1331
|
+
};
|
|
1332
|
+
previousPeriod?: Record<string, never>;
|
|
1333
|
+
/** @enum {string} */
|
|
1334
|
+
depth?: "basic" | "advanced";
|
|
1335
|
+
typesPresent?: string[];
|
|
1336
|
+
};
|
|
1337
|
+
/** @description uptimePct (incident-based: confirmed critical incidents only, maintenance neutral, weighted by observed time) / checkSuccessPct (successful ÷ total checks) / incidents / criticalIncidents / downtimeMs as compared values; mttrMs/mttaMs/mtbfMs nullable; longestIncident; totalChecks; monitorsCovered */
|
|
1338
|
+
summary?: Record<string, never>;
|
|
1339
|
+
/** @description Fleet avg/min/max ms + slow-check count over latency-style monitor types */
|
|
1340
|
+
responseTime?: Record<string, never> | null;
|
|
1341
|
+
/** @description Per-monitor rows, worst uptime first */
|
|
1342
|
+
monitors?: {
|
|
1343
|
+
monitorId?: string;
|
|
1344
|
+
name?: string;
|
|
1345
|
+
type?: string;
|
|
1346
|
+
/** @description Incident-based, same formula as the monitor's Uptime card */
|
|
1347
|
+
uptimePct?: Record<string, never>;
|
|
1348
|
+
downtimeMs?: number;
|
|
1349
|
+
checkSuccessPct?: number;
|
|
1350
|
+
avgMs?: number;
|
|
1351
|
+
p95Ms?: number;
|
|
1352
|
+
incidents?: number;
|
|
1353
|
+
hadMaintenance?: boolean;
|
|
1354
|
+
}[];
|
|
1355
|
+
totalMonitors?: number;
|
|
1356
|
+
/** @description Type-aware sections keyed locations/ssl/domains/cwv/heartbeat/blacklist/mcp — only the keys the org's monitors produce (locations needs latency-style monitors), advanced depth only */
|
|
1357
|
+
sections?: Record<string, never>;
|
|
1358
|
+
/** @description Sections that exist for this org's monitors but are locked by the plan (empty on advanced depth) */
|
|
1359
|
+
gatedSections?: (
|
|
1360
|
+
| "locations"
|
|
1361
|
+
| "ssl"
|
|
1362
|
+
| "domains"
|
|
1363
|
+
| "cwv"
|
|
1364
|
+
| "heartbeat"
|
|
1365
|
+
| "blacklist"
|
|
1366
|
+
| "mcp"
|
|
1367
|
+
)[];
|
|
1368
|
+
/** @description Plain-language findings, most severe first, tone good|warning|critical|neutral */
|
|
1369
|
+
insights?: {
|
|
1370
|
+
tone?: string;
|
|
1371
|
+
text?: string;
|
|
1372
|
+
monitorId?: string;
|
|
1373
|
+
}[];
|
|
1374
|
+
/** @description Insights withheld beyond the plan's cap (0 on advanced depth) */
|
|
1375
|
+
gatedInsightCount?: number;
|
|
1376
|
+
};
|
|
1082
1377
|
OncallSchedule: {
|
|
1083
1378
|
id?: number;
|
|
1084
1379
|
/** @constant */
|
|
@@ -1093,6 +1388,100 @@ export interface components {
|
|
|
1093
1388
|
email?: string;
|
|
1094
1389
|
} | null;
|
|
1095
1390
|
};
|
|
1391
|
+
MonitorTypeList: {
|
|
1392
|
+
/** @constant */
|
|
1393
|
+
object: "list";
|
|
1394
|
+
data: components["schemas"]["MonitorType"][];
|
|
1395
|
+
has_more: boolean;
|
|
1396
|
+
};
|
|
1397
|
+
MonitorList: {
|
|
1398
|
+
/** @constant */
|
|
1399
|
+
object: "list";
|
|
1400
|
+
data: components["schemas"]["Monitor"][];
|
|
1401
|
+
has_more: boolean;
|
|
1402
|
+
next_cursor?: string | null;
|
|
1403
|
+
};
|
|
1404
|
+
CheckList: {
|
|
1405
|
+
/** @constant */
|
|
1406
|
+
object: "list";
|
|
1407
|
+
data: components["schemas"]["Check"][];
|
|
1408
|
+
has_more: boolean;
|
|
1409
|
+
locations?: Record<string, never>[];
|
|
1410
|
+
};
|
|
1411
|
+
AlertRuleList: {
|
|
1412
|
+
/** @constant */
|
|
1413
|
+
object: "list";
|
|
1414
|
+
data: components["schemas"]["AlertRule"][];
|
|
1415
|
+
has_more: boolean;
|
|
1416
|
+
};
|
|
1417
|
+
LocationList: {
|
|
1418
|
+
/** @constant */
|
|
1419
|
+
object: "list";
|
|
1420
|
+
data: components["schemas"]["Location"][];
|
|
1421
|
+
has_more: boolean;
|
|
1422
|
+
};
|
|
1423
|
+
IncidentList: {
|
|
1424
|
+
/** @constant */
|
|
1425
|
+
object: "list";
|
|
1426
|
+
data: components["schemas"]["Incident"][];
|
|
1427
|
+
has_more: boolean;
|
|
1428
|
+
total?: number;
|
|
1429
|
+
};
|
|
1430
|
+
MaintenanceWindowList: {
|
|
1431
|
+
/** @constant */
|
|
1432
|
+
object: "list";
|
|
1433
|
+
data: components["schemas"]["MaintenanceWindow"][];
|
|
1434
|
+
has_more: boolean;
|
|
1435
|
+
};
|
|
1436
|
+
ContactList: {
|
|
1437
|
+
/** @constant */
|
|
1438
|
+
object: "list";
|
|
1439
|
+
data: components["schemas"]["Contact"][];
|
|
1440
|
+
has_more: boolean;
|
|
1441
|
+
};
|
|
1442
|
+
ContactGroupList: {
|
|
1443
|
+
/** @constant */
|
|
1444
|
+
object: "list";
|
|
1445
|
+
data: components["schemas"]["ContactGroup"][];
|
|
1446
|
+
has_more: boolean;
|
|
1447
|
+
};
|
|
1448
|
+
StatusPageList: {
|
|
1449
|
+
/** @constant */
|
|
1450
|
+
object: "list";
|
|
1451
|
+
data: components["schemas"]["StatusPage"][];
|
|
1452
|
+
has_more: boolean;
|
|
1453
|
+
};
|
|
1454
|
+
AnnouncementList: {
|
|
1455
|
+
/** @constant */
|
|
1456
|
+
object: "list";
|
|
1457
|
+
data: components["schemas"]["Announcement"][];
|
|
1458
|
+
has_more: boolean;
|
|
1459
|
+
};
|
|
1460
|
+
OncallScheduleList: {
|
|
1461
|
+
/** @constant */
|
|
1462
|
+
object: "list";
|
|
1463
|
+
data: components["schemas"]["OncallSchedule"][];
|
|
1464
|
+
has_more: boolean;
|
|
1465
|
+
};
|
|
1466
|
+
NotificationList: {
|
|
1467
|
+
/** @constant */
|
|
1468
|
+
object: "list";
|
|
1469
|
+
data: components["schemas"]["Notification"][];
|
|
1470
|
+
has_more: boolean;
|
|
1471
|
+
total?: number;
|
|
1472
|
+
};
|
|
1473
|
+
ActivityEventList: {
|
|
1474
|
+
/** @constant */
|
|
1475
|
+
object: "list";
|
|
1476
|
+
data: components["schemas"]["ActivityEvent"][];
|
|
1477
|
+
has_more: boolean;
|
|
1478
|
+
};
|
|
1479
|
+
ReportScheduleList: {
|
|
1480
|
+
/** @constant */
|
|
1481
|
+
object: "list";
|
|
1482
|
+
data: components["schemas"]["ReportSchedule"][];
|
|
1483
|
+
has_more: boolean;
|
|
1484
|
+
};
|
|
1096
1485
|
};
|
|
1097
1486
|
responses: never;
|
|
1098
1487
|
parameters: never;
|
|
@@ -1116,7 +1505,9 @@ export interface operations {
|
|
|
1116
1505
|
headers: {
|
|
1117
1506
|
[name: string]: unknown;
|
|
1118
1507
|
};
|
|
1119
|
-
content
|
|
1508
|
+
content: {
|
|
1509
|
+
"application/json": components["schemas"]["Me"];
|
|
1510
|
+
};
|
|
1120
1511
|
};
|
|
1121
1512
|
};
|
|
1122
1513
|
};
|
|
@@ -1134,7 +1525,9 @@ export interface operations {
|
|
|
1134
1525
|
headers: {
|
|
1135
1526
|
[name: string]: unknown;
|
|
1136
1527
|
};
|
|
1137
|
-
content
|
|
1528
|
+
content: {
|
|
1529
|
+
"application/json": components["schemas"]["OpenApiDocument"];
|
|
1530
|
+
};
|
|
1138
1531
|
};
|
|
1139
1532
|
};
|
|
1140
1533
|
};
|
|
@@ -1152,7 +1545,50 @@ export interface operations {
|
|
|
1152
1545
|
headers: {
|
|
1153
1546
|
[name: string]: unknown;
|
|
1154
1547
|
};
|
|
1155
|
-
content
|
|
1548
|
+
content: {
|
|
1549
|
+
"application/json": components["schemas"]["MonitorTypeList"];
|
|
1550
|
+
};
|
|
1551
|
+
};
|
|
1552
|
+
};
|
|
1553
|
+
};
|
|
1554
|
+
batchOperations: {
|
|
1555
|
+
parameters: {
|
|
1556
|
+
query?: never;
|
|
1557
|
+
header?: never;
|
|
1558
|
+
path?: never;
|
|
1559
|
+
cookie?: never;
|
|
1560
|
+
};
|
|
1561
|
+
requestBody: {
|
|
1562
|
+
content: {
|
|
1563
|
+
"application/json": {
|
|
1564
|
+
operations: {
|
|
1565
|
+
/** @enum {string} */
|
|
1566
|
+
method: "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
|
|
1567
|
+
/** @description Relative /api/v1 sub-path, e.g. /monitors/{id} */
|
|
1568
|
+
path: string;
|
|
1569
|
+
body?: Record<string, never>;
|
|
1570
|
+
}[];
|
|
1571
|
+
};
|
|
1572
|
+
};
|
|
1573
|
+
};
|
|
1574
|
+
responses: {
|
|
1575
|
+
/** @description Per-operation results in request order */
|
|
1576
|
+
200: {
|
|
1577
|
+
headers: {
|
|
1578
|
+
[name: string]: unknown;
|
|
1579
|
+
};
|
|
1580
|
+
content: {
|
|
1581
|
+
"application/json": components["schemas"]["BatchResult"];
|
|
1582
|
+
};
|
|
1583
|
+
};
|
|
1584
|
+
/** @description Error */
|
|
1585
|
+
default: {
|
|
1586
|
+
headers: {
|
|
1587
|
+
[name: string]: unknown;
|
|
1588
|
+
};
|
|
1589
|
+
content: {
|
|
1590
|
+
"application/json": components["schemas"]["Error"];
|
|
1591
|
+
};
|
|
1156
1592
|
};
|
|
1157
1593
|
};
|
|
1158
1594
|
};
|
|
@@ -1162,7 +1598,8 @@ export interface operations {
|
|
|
1162
1598
|
limit?: number;
|
|
1163
1599
|
cursor?: string;
|
|
1164
1600
|
type?: string;
|
|
1165
|
-
status
|
|
1601
|
+
/** @description Effective status: down = confirmed critical incident open; degraded = failed check not yet confirmed, or an open warning incident */
|
|
1602
|
+
status?: "up" | "degraded" | "down" | "paused" | "unknown";
|
|
1166
1603
|
tag?: string;
|
|
1167
1604
|
/** @description Case-insensitive substring search over name and target */
|
|
1168
1605
|
q?: string;
|
|
@@ -1179,13 +1616,7 @@ export interface operations {
|
|
|
1179
1616
|
[name: string]: unknown;
|
|
1180
1617
|
};
|
|
1181
1618
|
content: {
|
|
1182
|
-
"application/json":
|
|
1183
|
-
/** @constant */
|
|
1184
|
-
object?: "list";
|
|
1185
|
-
data?: components["schemas"]["Monitor"][];
|
|
1186
|
-
has_more?: boolean;
|
|
1187
|
-
next_cursor?: string | null;
|
|
1188
|
-
};
|
|
1619
|
+
"application/json": components["schemas"]["MonitorList"];
|
|
1189
1620
|
};
|
|
1190
1621
|
};
|
|
1191
1622
|
/** @description Error */
|
|
@@ -1319,12 +1750,14 @@ export interface operations {
|
|
|
1319
1750
|
};
|
|
1320
1751
|
requestBody?: never;
|
|
1321
1752
|
responses: {
|
|
1322
|
-
/** @description Deleted */
|
|
1323
|
-
|
|
1753
|
+
/** @description Deleted — returns a confirmation with the removed id */
|
|
1754
|
+
200: {
|
|
1324
1755
|
headers: {
|
|
1325
1756
|
[name: string]: unknown;
|
|
1326
1757
|
};
|
|
1327
|
-
content
|
|
1758
|
+
content: {
|
|
1759
|
+
"application/json": components["schemas"]["Deleted"];
|
|
1760
|
+
};
|
|
1328
1761
|
};
|
|
1329
1762
|
/** @description Error */
|
|
1330
1763
|
default: {
|
|
@@ -1458,12 +1891,14 @@ export interface operations {
|
|
|
1458
1891
|
};
|
|
1459
1892
|
requestBody?: never;
|
|
1460
1893
|
responses: {
|
|
1461
|
-
/** @description Check dispatched */
|
|
1894
|
+
/** @description Check dispatched (async) */
|
|
1462
1895
|
202: {
|
|
1463
1896
|
headers: {
|
|
1464
1897
|
[name: string]: unknown;
|
|
1465
1898
|
};
|
|
1466
|
-
content
|
|
1899
|
+
content: {
|
|
1900
|
+
"application/json": components["schemas"]["Ack"];
|
|
1901
|
+
};
|
|
1467
1902
|
};
|
|
1468
1903
|
/** @description Error */
|
|
1469
1904
|
default: {
|
|
@@ -1515,6 +1950,8 @@ export interface operations {
|
|
|
1515
1950
|
query?: {
|
|
1516
1951
|
hours?: number;
|
|
1517
1952
|
limit?: number;
|
|
1953
|
+
/** @description true = only passing checks, false = only failed checks (one-call failure forensics); omit for all. The per-location breakdown ignores this filter. */
|
|
1954
|
+
success?: boolean;
|
|
1518
1955
|
};
|
|
1519
1956
|
header?: never;
|
|
1520
1957
|
path: {
|
|
@@ -1531,13 +1968,7 @@ export interface operations {
|
|
|
1531
1968
|
[name: string]: unknown;
|
|
1532
1969
|
};
|
|
1533
1970
|
content: {
|
|
1534
|
-
"application/json":
|
|
1535
|
-
/** @constant */
|
|
1536
|
-
object?: "list";
|
|
1537
|
-
data?: components["schemas"]["Check"][];
|
|
1538
|
-
has_more?: boolean;
|
|
1539
|
-
locations?: Record<string, never>[];
|
|
1540
|
-
};
|
|
1971
|
+
"application/json": components["schemas"]["CheckList"];
|
|
1541
1972
|
};
|
|
1542
1973
|
};
|
|
1543
1974
|
/** @description Error */
|
|
@@ -1569,12 +2000,7 @@ export interface operations {
|
|
|
1569
2000
|
[name: string]: unknown;
|
|
1570
2001
|
};
|
|
1571
2002
|
content: {
|
|
1572
|
-
"application/json":
|
|
1573
|
-
/** @constant */
|
|
1574
|
-
object?: "list";
|
|
1575
|
-
data?: components["schemas"]["AlertRule"][];
|
|
1576
|
-
has_more?: boolean;
|
|
1577
|
-
};
|
|
2003
|
+
"application/json": components["schemas"]["AlertRuleList"];
|
|
1578
2004
|
};
|
|
1579
2005
|
};
|
|
1580
2006
|
/** @description Error */
|
|
@@ -1675,12 +2101,14 @@ export interface operations {
|
|
|
1675
2101
|
};
|
|
1676
2102
|
requestBody?: never;
|
|
1677
2103
|
responses: {
|
|
1678
|
-
/** @description Deleted */
|
|
1679
|
-
|
|
2104
|
+
/** @description Deleted — returns a confirmation with the removed id */
|
|
2105
|
+
200: {
|
|
1680
2106
|
headers: {
|
|
1681
2107
|
[name: string]: unknown;
|
|
1682
2108
|
};
|
|
1683
|
-
content
|
|
2109
|
+
content: {
|
|
2110
|
+
"application/json": components["schemas"]["Deleted"];
|
|
2111
|
+
};
|
|
1684
2112
|
};
|
|
1685
2113
|
/** @description Error */
|
|
1686
2114
|
default: {
|
|
@@ -1705,7 +2133,11 @@ export interface operations {
|
|
|
1705
2133
|
};
|
|
1706
2134
|
cookie?: never;
|
|
1707
2135
|
};
|
|
1708
|
-
requestBody?:
|
|
2136
|
+
requestBody?: {
|
|
2137
|
+
content: {
|
|
2138
|
+
"application/json": components["schemas"]["AlertRuleUpdate"];
|
|
2139
|
+
};
|
|
2140
|
+
};
|
|
1709
2141
|
responses: {
|
|
1710
2142
|
/** @description OK */
|
|
1711
2143
|
200: {
|
|
@@ -1742,12 +2174,7 @@ export interface operations {
|
|
|
1742
2174
|
[name: string]: unknown;
|
|
1743
2175
|
};
|
|
1744
2176
|
content: {
|
|
1745
|
-
"application/json":
|
|
1746
|
-
/** @constant */
|
|
1747
|
-
object?: "list";
|
|
1748
|
-
data?: components["schemas"]["Location"][];
|
|
1749
|
-
has_more?: boolean;
|
|
1750
|
-
};
|
|
2177
|
+
"application/json": components["schemas"]["LocationList"];
|
|
1751
2178
|
};
|
|
1752
2179
|
};
|
|
1753
2180
|
/** @description Error */
|
|
@@ -1788,13 +2215,7 @@ export interface operations {
|
|
|
1788
2215
|
[name: string]: unknown;
|
|
1789
2216
|
};
|
|
1790
2217
|
content: {
|
|
1791
|
-
"application/json":
|
|
1792
|
-
/** @constant */
|
|
1793
|
-
object?: "list";
|
|
1794
|
-
data?: components["schemas"]["Incident"][];
|
|
1795
|
-
has_more?: boolean;
|
|
1796
|
-
total?: number;
|
|
1797
|
-
};
|
|
2218
|
+
"application/json": components["schemas"]["IncidentList"];
|
|
1798
2219
|
};
|
|
1799
2220
|
};
|
|
1800
2221
|
/** @description Error */
|
|
@@ -1934,12 +2355,14 @@ export interface operations {
|
|
|
1934
2355
|
};
|
|
1935
2356
|
requestBody?: never;
|
|
1936
2357
|
responses: {
|
|
1937
|
-
/** @description
|
|
2358
|
+
/** @description Incident marked as maintenance */
|
|
1938
2359
|
200: {
|
|
1939
2360
|
headers: {
|
|
1940
2361
|
[name: string]: unknown;
|
|
1941
2362
|
};
|
|
1942
|
-
content
|
|
2363
|
+
content: {
|
|
2364
|
+
"application/json": components["schemas"]["Incident"];
|
|
2365
|
+
};
|
|
1943
2366
|
};
|
|
1944
2367
|
/** @description Marked; returns the maintenance window */
|
|
1945
2368
|
201: {
|
|
@@ -1978,12 +2401,7 @@ export interface operations {
|
|
|
1978
2401
|
[name: string]: unknown;
|
|
1979
2402
|
};
|
|
1980
2403
|
content: {
|
|
1981
|
-
"application/json":
|
|
1982
|
-
/** @constant */
|
|
1983
|
-
object?: "list";
|
|
1984
|
-
data?: components["schemas"]["MaintenanceWindow"][];
|
|
1985
|
-
has_more?: boolean;
|
|
1986
|
-
};
|
|
2404
|
+
"application/json": components["schemas"]["MaintenanceWindowList"];
|
|
1987
2405
|
};
|
|
1988
2406
|
};
|
|
1989
2407
|
/** @description Error */
|
|
@@ -2077,12 +2495,14 @@ export interface operations {
|
|
|
2077
2495
|
};
|
|
2078
2496
|
requestBody?: never;
|
|
2079
2497
|
responses: {
|
|
2080
|
-
/** @description Deleted */
|
|
2081
|
-
|
|
2498
|
+
/** @description Deleted — returns a confirmation with the removed id */
|
|
2499
|
+
200: {
|
|
2082
2500
|
headers: {
|
|
2083
2501
|
[name: string]: unknown;
|
|
2084
2502
|
};
|
|
2085
|
-
content
|
|
2503
|
+
content: {
|
|
2504
|
+
"application/json": components["schemas"]["Deleted"];
|
|
2505
|
+
};
|
|
2086
2506
|
};
|
|
2087
2507
|
/** @description Error */
|
|
2088
2508
|
default: {
|
|
@@ -2105,7 +2525,11 @@ export interface operations {
|
|
|
2105
2525
|
};
|
|
2106
2526
|
cookie?: never;
|
|
2107
2527
|
};
|
|
2108
|
-
requestBody?:
|
|
2528
|
+
requestBody?: {
|
|
2529
|
+
content: {
|
|
2530
|
+
"application/json": components["schemas"]["MaintenanceWindowUpdate"];
|
|
2531
|
+
};
|
|
2532
|
+
};
|
|
2109
2533
|
responses: {
|
|
2110
2534
|
/** @description OK */
|
|
2111
2535
|
200: {
|
|
@@ -2146,12 +2570,7 @@ export interface operations {
|
|
|
2146
2570
|
[name: string]: unknown;
|
|
2147
2571
|
};
|
|
2148
2572
|
content: {
|
|
2149
|
-
"application/json":
|
|
2150
|
-
/** @constant */
|
|
2151
|
-
object?: "list";
|
|
2152
|
-
data?: components["schemas"]["Contact"][];
|
|
2153
|
-
has_more?: boolean;
|
|
2154
|
-
};
|
|
2573
|
+
"application/json": components["schemas"]["ContactList"];
|
|
2155
2574
|
};
|
|
2156
2575
|
};
|
|
2157
2576
|
/** @description Error */
|
|
@@ -2251,12 +2670,14 @@ export interface operations {
|
|
|
2251
2670
|
};
|
|
2252
2671
|
requestBody?: never;
|
|
2253
2672
|
responses: {
|
|
2254
|
-
/** @description Deleted */
|
|
2255
|
-
|
|
2673
|
+
/** @description Deleted — returns a confirmation with the removed id */
|
|
2674
|
+
200: {
|
|
2256
2675
|
headers: {
|
|
2257
2676
|
[name: string]: unknown;
|
|
2258
2677
|
};
|
|
2259
|
-
content
|
|
2678
|
+
content: {
|
|
2679
|
+
"application/json": components["schemas"]["Deleted"];
|
|
2680
|
+
};
|
|
2260
2681
|
};
|
|
2261
2682
|
/** @description Error */
|
|
2262
2683
|
default: {
|
|
@@ -2279,7 +2700,11 @@ export interface operations {
|
|
|
2279
2700
|
};
|
|
2280
2701
|
cookie?: never;
|
|
2281
2702
|
};
|
|
2282
|
-
requestBody?:
|
|
2703
|
+
requestBody?: {
|
|
2704
|
+
content: {
|
|
2705
|
+
"application/json": components["schemas"]["ContactUpdate"];
|
|
2706
|
+
};
|
|
2707
|
+
};
|
|
2283
2708
|
responses: {
|
|
2284
2709
|
/** @description OK */
|
|
2285
2710
|
200: {
|
|
@@ -2320,12 +2745,7 @@ export interface operations {
|
|
|
2320
2745
|
[name: string]: unknown;
|
|
2321
2746
|
};
|
|
2322
2747
|
content: {
|
|
2323
|
-
"application/json":
|
|
2324
|
-
/** @constant */
|
|
2325
|
-
object?: "list";
|
|
2326
|
-
data?: components["schemas"]["ContactGroup"][];
|
|
2327
|
-
has_more?: boolean;
|
|
2328
|
-
};
|
|
2748
|
+
"application/json": components["schemas"]["ContactGroupList"];
|
|
2329
2749
|
};
|
|
2330
2750
|
};
|
|
2331
2751
|
/** @description Error */
|
|
@@ -2349,7 +2769,11 @@ export interface operations {
|
|
|
2349
2769
|
path?: never;
|
|
2350
2770
|
cookie?: never;
|
|
2351
2771
|
};
|
|
2352
|
-
requestBody
|
|
2772
|
+
requestBody: {
|
|
2773
|
+
content: {
|
|
2774
|
+
"application/json": components["schemas"]["ContactGroupCreate"];
|
|
2775
|
+
};
|
|
2776
|
+
};
|
|
2353
2777
|
responses: {
|
|
2354
2778
|
/** @description Created */
|
|
2355
2779
|
201: {
|
|
@@ -2415,12 +2839,14 @@ export interface operations {
|
|
|
2415
2839
|
};
|
|
2416
2840
|
requestBody?: never;
|
|
2417
2841
|
responses: {
|
|
2418
|
-
/** @description Deleted */
|
|
2419
|
-
|
|
2842
|
+
/** @description Deleted — returns a confirmation with the removed id */
|
|
2843
|
+
200: {
|
|
2420
2844
|
headers: {
|
|
2421
2845
|
[name: string]: unknown;
|
|
2422
2846
|
};
|
|
2423
|
-
content
|
|
2847
|
+
content: {
|
|
2848
|
+
"application/json": components["schemas"]["Deleted"];
|
|
2849
|
+
};
|
|
2424
2850
|
};
|
|
2425
2851
|
/** @description Error */
|
|
2426
2852
|
default: {
|
|
@@ -2443,7 +2869,11 @@ export interface operations {
|
|
|
2443
2869
|
};
|
|
2444
2870
|
cookie?: never;
|
|
2445
2871
|
};
|
|
2446
|
-
requestBody?:
|
|
2872
|
+
requestBody?: {
|
|
2873
|
+
content: {
|
|
2874
|
+
"application/json": components["schemas"]["ContactGroupUpdate"];
|
|
2875
|
+
};
|
|
2876
|
+
};
|
|
2447
2877
|
responses: {
|
|
2448
2878
|
/** @description OK */
|
|
2449
2879
|
200: {
|
|
@@ -2480,12 +2910,7 @@ export interface operations {
|
|
|
2480
2910
|
[name: string]: unknown;
|
|
2481
2911
|
};
|
|
2482
2912
|
content: {
|
|
2483
|
-
"application/json":
|
|
2484
|
-
/** @constant */
|
|
2485
|
-
object?: "list";
|
|
2486
|
-
data?: components["schemas"]["StatusPage"][];
|
|
2487
|
-
has_more?: boolean;
|
|
2488
|
-
};
|
|
2913
|
+
"application/json": components["schemas"]["StatusPageList"];
|
|
2489
2914
|
};
|
|
2490
2915
|
};
|
|
2491
2916
|
/** @description Error */
|
|
@@ -2509,7 +2934,11 @@ export interface operations {
|
|
|
2509
2934
|
path?: never;
|
|
2510
2935
|
cookie?: never;
|
|
2511
2936
|
};
|
|
2512
|
-
requestBody
|
|
2937
|
+
requestBody: {
|
|
2938
|
+
content: {
|
|
2939
|
+
"application/json": components["schemas"]["StatusPageCreate"];
|
|
2940
|
+
};
|
|
2941
|
+
};
|
|
2513
2942
|
responses: {
|
|
2514
2943
|
/** @description Created */
|
|
2515
2944
|
201: {
|
|
@@ -2575,12 +3004,14 @@ export interface operations {
|
|
|
2575
3004
|
};
|
|
2576
3005
|
requestBody?: never;
|
|
2577
3006
|
responses: {
|
|
2578
|
-
/** @description Deleted */
|
|
2579
|
-
|
|
3007
|
+
/** @description Deleted — returns a confirmation with the removed id */
|
|
3008
|
+
200: {
|
|
2580
3009
|
headers: {
|
|
2581
3010
|
[name: string]: unknown;
|
|
2582
3011
|
};
|
|
2583
|
-
content
|
|
3012
|
+
content: {
|
|
3013
|
+
"application/json": components["schemas"]["Deleted"];
|
|
3014
|
+
};
|
|
2584
3015
|
};
|
|
2585
3016
|
/** @description Error */
|
|
2586
3017
|
default: {
|
|
@@ -2603,7 +3034,11 @@ export interface operations {
|
|
|
2603
3034
|
};
|
|
2604
3035
|
cookie?: never;
|
|
2605
3036
|
};
|
|
2606
|
-
requestBody?:
|
|
3037
|
+
requestBody?: {
|
|
3038
|
+
content: {
|
|
3039
|
+
"application/json": components["schemas"]["StatusPageUpdate"];
|
|
3040
|
+
};
|
|
3041
|
+
};
|
|
2607
3042
|
responses: {
|
|
2608
3043
|
/** @description OK */
|
|
2609
3044
|
200: {
|
|
@@ -2643,12 +3078,7 @@ export interface operations {
|
|
|
2643
3078
|
[name: string]: unknown;
|
|
2644
3079
|
};
|
|
2645
3080
|
content: {
|
|
2646
|
-
"application/json":
|
|
2647
|
-
/** @constant */
|
|
2648
|
-
object?: "list";
|
|
2649
|
-
data?: components["schemas"]["Announcement"][];
|
|
2650
|
-
has_more?: boolean;
|
|
2651
|
-
};
|
|
3081
|
+
"application/json": components["schemas"]["AnnouncementList"];
|
|
2652
3082
|
};
|
|
2653
3083
|
};
|
|
2654
3084
|
/** @description Error */
|
|
@@ -2675,7 +3105,11 @@ export interface operations {
|
|
|
2675
3105
|
};
|
|
2676
3106
|
cookie?: never;
|
|
2677
3107
|
};
|
|
2678
|
-
requestBody
|
|
3108
|
+
requestBody: {
|
|
3109
|
+
content: {
|
|
3110
|
+
"application/json": components["schemas"]["AnnouncementCreate"];
|
|
3111
|
+
};
|
|
3112
|
+
};
|
|
2679
3113
|
responses: {
|
|
2680
3114
|
/** @description Created */
|
|
2681
3115
|
201: {
|
|
@@ -2745,12 +3179,14 @@ export interface operations {
|
|
|
2745
3179
|
};
|
|
2746
3180
|
requestBody?: never;
|
|
2747
3181
|
responses: {
|
|
2748
|
-
/** @description Deleted */
|
|
2749
|
-
|
|
3182
|
+
/** @description Deleted — returns a confirmation with the removed id */
|
|
3183
|
+
200: {
|
|
2750
3184
|
headers: {
|
|
2751
3185
|
[name: string]: unknown;
|
|
2752
3186
|
};
|
|
2753
|
-
content
|
|
3187
|
+
content: {
|
|
3188
|
+
"application/json": components["schemas"]["Deleted"];
|
|
3189
|
+
};
|
|
2754
3190
|
};
|
|
2755
3191
|
/** @description Error */
|
|
2756
3192
|
default: {
|
|
@@ -2775,7 +3211,11 @@ export interface operations {
|
|
|
2775
3211
|
};
|
|
2776
3212
|
cookie?: never;
|
|
2777
3213
|
};
|
|
2778
|
-
requestBody
|
|
3214
|
+
requestBody: {
|
|
3215
|
+
content: {
|
|
3216
|
+
"application/json": components["schemas"]["AnnouncementUpdate"];
|
|
3217
|
+
};
|
|
3218
|
+
};
|
|
2779
3219
|
responses: {
|
|
2780
3220
|
/** @description OK */
|
|
2781
3221
|
200: {
|
|
@@ -2841,12 +3281,7 @@ export interface operations {
|
|
|
2841
3281
|
[name: string]: unknown;
|
|
2842
3282
|
};
|
|
2843
3283
|
content: {
|
|
2844
|
-
"application/json":
|
|
2845
|
-
/** @constant */
|
|
2846
|
-
object?: "list";
|
|
2847
|
-
data?: components["schemas"]["OncallSchedule"][];
|
|
2848
|
-
has_more?: boolean;
|
|
2849
|
-
};
|
|
3284
|
+
"application/json": components["schemas"]["OncallScheduleList"];
|
|
2850
3285
|
};
|
|
2851
3286
|
};
|
|
2852
3287
|
/** @description Error */
|
|
@@ -2885,13 +3320,7 @@ export interface operations {
|
|
|
2885
3320
|
[name: string]: unknown;
|
|
2886
3321
|
};
|
|
2887
3322
|
content: {
|
|
2888
|
-
"application/json":
|
|
2889
|
-
/** @constant */
|
|
2890
|
-
object?: "list";
|
|
2891
|
-
data?: components["schemas"]["Notification"][];
|
|
2892
|
-
has_more?: boolean;
|
|
2893
|
-
total?: number;
|
|
2894
|
-
};
|
|
3323
|
+
"application/json": components["schemas"]["NotificationList"];
|
|
2895
3324
|
};
|
|
2896
3325
|
};
|
|
2897
3326
|
/** @description Error */
|
|
@@ -2930,12 +3359,7 @@ export interface operations {
|
|
|
2930
3359
|
[name: string]: unknown;
|
|
2931
3360
|
};
|
|
2932
3361
|
content: {
|
|
2933
|
-
"application/json":
|
|
2934
|
-
/** @constant */
|
|
2935
|
-
object?: "list";
|
|
2936
|
-
data?: components["schemas"]["ActivityEvent"][];
|
|
2937
|
-
has_more?: boolean;
|
|
2938
|
-
};
|
|
3362
|
+
"application/json": components["schemas"]["ActivityEventList"];
|
|
2939
3363
|
};
|
|
2940
3364
|
};
|
|
2941
3365
|
/** @description Error */
|
|
@@ -3009,4 +3433,121 @@ export interface operations {
|
|
|
3009
3433
|
};
|
|
3010
3434
|
};
|
|
3011
3435
|
};
|
|
3436
|
+
getReport: {
|
|
3437
|
+
parameters: {
|
|
3438
|
+
query?: {
|
|
3439
|
+
/** @description Preset trailing window (ignored when from/to given) */
|
|
3440
|
+
period?: "7d" | "30d";
|
|
3441
|
+
/** @description Custom period start (ISO 8601 or Unix epoch). Needs the advanced-reports plan capability; max 92 days. */
|
|
3442
|
+
from?: string;
|
|
3443
|
+
/** @description Custom period end (ISO 8601 or Unix epoch) */
|
|
3444
|
+
to?: string;
|
|
3445
|
+
/** @description Comma-separated monitor IDs to scope the report to (advanced-reports plans). Combined with `tags` as a union. */
|
|
3446
|
+
monitor_ids?: string;
|
|
3447
|
+
/** @description Comma-separated monitor tags to scope the report to (advanced-reports plans) */
|
|
3448
|
+
tags?: string;
|
|
3449
|
+
/** @description Comma-separated subset of type-aware sections to generate: locations,ssl,domains,cwv,heartbeat,blacklist,mcp (advanced-reports plans; omit for all) */
|
|
3450
|
+
sections?: string;
|
|
3451
|
+
/** @description Set false to drop the response-time block */
|
|
3452
|
+
response_time?: boolean;
|
|
3453
|
+
/** @description Set false to drop the per-monitor table */
|
|
3454
|
+
monitors_table?: boolean;
|
|
3455
|
+
/** @description Set false to drop the insights block */
|
|
3456
|
+
insights?: boolean;
|
|
3457
|
+
/** @description Comma-separated subset of acknowledged, resolved, open (or `all`). Filters incident aggregates (counts, MTTR/MTTA, downtime, per-monitor column) to incidents in any selected state; uptime stays check-based (advanced-reports plans) */
|
|
3458
|
+
incident_status?: string;
|
|
3459
|
+
};
|
|
3460
|
+
header?: never;
|
|
3461
|
+
path?: never;
|
|
3462
|
+
cookie?: never;
|
|
3463
|
+
};
|
|
3464
|
+
requestBody?: never;
|
|
3465
|
+
responses: {
|
|
3466
|
+
/** @description OK */
|
|
3467
|
+
200: {
|
|
3468
|
+
headers: {
|
|
3469
|
+
[name: string]: unknown;
|
|
3470
|
+
};
|
|
3471
|
+
content: {
|
|
3472
|
+
"application/json": components["schemas"]["Report"];
|
|
3473
|
+
};
|
|
3474
|
+
};
|
|
3475
|
+
/** @description Error */
|
|
3476
|
+
default: {
|
|
3477
|
+
headers: {
|
|
3478
|
+
[name: string]: unknown;
|
|
3479
|
+
};
|
|
3480
|
+
content: {
|
|
3481
|
+
"application/json": components["schemas"]["Error"];
|
|
3482
|
+
};
|
|
3483
|
+
};
|
|
3484
|
+
};
|
|
3485
|
+
};
|
|
3486
|
+
listReportSchedules: {
|
|
3487
|
+
parameters: {
|
|
3488
|
+
query?: never;
|
|
3489
|
+
header?: never;
|
|
3490
|
+
path?: never;
|
|
3491
|
+
cookie?: never;
|
|
3492
|
+
};
|
|
3493
|
+
requestBody?: never;
|
|
3494
|
+
responses: {
|
|
3495
|
+
/** @description Both cadences, weekly first */
|
|
3496
|
+
200: {
|
|
3497
|
+
headers: {
|
|
3498
|
+
[name: string]: unknown;
|
|
3499
|
+
};
|
|
3500
|
+
content: {
|
|
3501
|
+
"application/json": components["schemas"]["ReportScheduleList"];
|
|
3502
|
+
};
|
|
3503
|
+
};
|
|
3504
|
+
/** @description Error */
|
|
3505
|
+
default: {
|
|
3506
|
+
headers: {
|
|
3507
|
+
[name: string]: unknown;
|
|
3508
|
+
};
|
|
3509
|
+
content: {
|
|
3510
|
+
"application/json": components["schemas"]["Error"];
|
|
3511
|
+
};
|
|
3512
|
+
};
|
|
3513
|
+
};
|
|
3514
|
+
};
|
|
3515
|
+
updateReportSchedule: {
|
|
3516
|
+
parameters: {
|
|
3517
|
+
query?: never;
|
|
3518
|
+
header?: never;
|
|
3519
|
+
path: {
|
|
3520
|
+
frequency: "weekly" | "monthly";
|
|
3521
|
+
};
|
|
3522
|
+
cookie?: never;
|
|
3523
|
+
};
|
|
3524
|
+
requestBody: {
|
|
3525
|
+
content: {
|
|
3526
|
+
"application/json": {
|
|
3527
|
+
enabled?: boolean;
|
|
3528
|
+
recipients?: string[];
|
|
3529
|
+
};
|
|
3530
|
+
};
|
|
3531
|
+
};
|
|
3532
|
+
responses: {
|
|
3533
|
+
/** @description OK */
|
|
3534
|
+
200: {
|
|
3535
|
+
headers: {
|
|
3536
|
+
[name: string]: unknown;
|
|
3537
|
+
};
|
|
3538
|
+
content: {
|
|
3539
|
+
"application/json": components["schemas"]["ReportSchedule"];
|
|
3540
|
+
};
|
|
3541
|
+
};
|
|
3542
|
+
/** @description Error */
|
|
3543
|
+
default: {
|
|
3544
|
+
headers: {
|
|
3545
|
+
[name: string]: unknown;
|
|
3546
|
+
};
|
|
3547
|
+
content: {
|
|
3548
|
+
"application/json": components["schemas"]["Error"];
|
|
3549
|
+
};
|
|
3550
|
+
};
|
|
3551
|
+
};
|
|
3552
|
+
};
|
|
3012
3553
|
}
|