watchfor 0.1.0 → 0.3.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 +1 -0
- package/dist/cli.js +16 -0
- package/dist/client.d.ts +23 -0
- package/dist/client.js +30 -0
- package/dist/schema.d.ts +532 -202
- package/package.json +2 -2
package/README.md
CHANGED
package/dist/cli.js
CHANGED
|
@@ -17,6 +17,7 @@ Usage:
|
|
|
17
17
|
watchfor monitors [query] List monitors (optional name/target search)
|
|
18
18
|
watchfor checks <monitor-id> [--failed]
|
|
19
19
|
Recent probe results for one monitor
|
|
20
|
+
watchfor report [--period 7d|30d] Org report vs the previous period
|
|
20
21
|
watchfor help
|
|
21
22
|
|
|
22
23
|
Environment:
|
|
@@ -53,6 +54,21 @@ async function main() {
|
|
|
53
54
|
console.log(`incidents: ${i.firing} firing (${i.firing_critical} critical) · ${i.acknowledged} acknowledged · ${i.started_24h} started in 24h`);
|
|
54
55
|
return 0;
|
|
55
56
|
}
|
|
57
|
+
case "report": {
|
|
58
|
+
const idx = args.indexOf("--period");
|
|
59
|
+
const period = idx !== -1 && (args[idx + 1] === "30d" || args[idx + 1] === "7d")
|
|
60
|
+
? args[idx + 1]
|
|
61
|
+
: "7d";
|
|
62
|
+
const r = (await wf.report({ period }));
|
|
63
|
+
const sm = r.summary ?? {};
|
|
64
|
+
const up = sm.uptimePct?.current;
|
|
65
|
+
const inc = sm.incidents?.current;
|
|
66
|
+
console.log(`report ${r.meta?.period?.label ?? period}: uptime ${up !== undefined ? `${up.toFixed(2)}%` : "n/a"} · ${inc ?? 0} incidents`);
|
|
67
|
+
for (const insight of r.insights ?? []) {
|
|
68
|
+
console.log(` [${insight.tone}] ${insight.text}`);
|
|
69
|
+
}
|
|
70
|
+
return 0;
|
|
71
|
+
}
|
|
56
72
|
case "incidents": {
|
|
57
73
|
const status = flag(args, "status");
|
|
58
74
|
const res = await wf.incidents.list({ status, limit: 25 });
|
package/dist/client.d.ts
CHANGED
|
@@ -55,6 +55,29 @@ export declare class WatchFor {
|
|
|
55
55
|
plan(): Promise<Plan>;
|
|
56
56
|
/** Aggregate incident stats: MTTR, MTBF, most unstable monitors. */
|
|
57
57
|
incidentStats(period?: "24h" | "7d" | "30d" | "90d"): Promise<IncidentStats>;
|
|
58
|
+
/**
|
|
59
|
+
* Org report for a period vs the previous one: uptime, incidents,
|
|
60
|
+
* MTTR/MTBF, response-time trend, per-monitor rows, type-aware
|
|
61
|
+
* sections and plain-language insights. Custom from/to (ISO 8601)
|
|
62
|
+
* needs the advanced-reports plan capability.
|
|
63
|
+
*/
|
|
64
|
+
report(opts?: {
|
|
65
|
+
period?: "7d" | "30d";
|
|
66
|
+
} | {
|
|
67
|
+
from: string | Date;
|
|
68
|
+
to: string | Date;
|
|
69
|
+
}): Promise<Record<string, unknown>>;
|
|
70
|
+
/** The org's two report-email cadences (weekly + monthly). */
|
|
71
|
+
reportSchedules(): Promise<List<Record<string, unknown>>>;
|
|
72
|
+
/**
|
|
73
|
+
* Toggle the weekly/monthly report email and/or replace its
|
|
74
|
+
* recipients (max 5). Enabling needs at least one recipient;
|
|
75
|
+
* clearing the recipients disables the cadence.
|
|
76
|
+
*/
|
|
77
|
+
setReportSchedule(frequency: "weekly" | "monthly", body: {
|
|
78
|
+
enabled?: boolean;
|
|
79
|
+
recipients?: string[];
|
|
80
|
+
}): Promise<Record<string, unknown>>;
|
|
58
81
|
/** Probe locations for monitor creation. */
|
|
59
82
|
locations(): Promise<List<Record<string, unknown>>>;
|
|
60
83
|
/** All 25 monitor types with exact alert metrics + config fields. */
|
package/dist/client.js
CHANGED
|
@@ -74,6 +74,36 @@ export class WatchFor {
|
|
|
74
74
|
incidentStats(period) {
|
|
75
75
|
return this.request("GET", "/incidents/stats", { query: { period } });
|
|
76
76
|
}
|
|
77
|
+
/**
|
|
78
|
+
* Org report for a period vs the previous one: uptime, incidents,
|
|
79
|
+
* MTTR/MTBF, response-time trend, per-monitor rows, type-aware
|
|
80
|
+
* sections and plain-language insights. Custom from/to (ISO 8601)
|
|
81
|
+
* needs the advanced-reports plan capability.
|
|
82
|
+
*/
|
|
83
|
+
report(opts) {
|
|
84
|
+
const query = {};
|
|
85
|
+
if (opts && "from" in opts) {
|
|
86
|
+
query.from =
|
|
87
|
+
opts.from instanceof Date ? opts.from.toISOString() : opts.from;
|
|
88
|
+
query.to = opts.to instanceof Date ? opts.to.toISOString() : opts.to;
|
|
89
|
+
}
|
|
90
|
+
else {
|
|
91
|
+
query.period = opts?.period;
|
|
92
|
+
}
|
|
93
|
+
return this.request("GET", "/reports", { query });
|
|
94
|
+
}
|
|
95
|
+
/** The org's two report-email cadences (weekly + monthly). */
|
|
96
|
+
reportSchedules() {
|
|
97
|
+
return this.request("GET", "/reports/schedules");
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* Toggle the weekly/monthly report email and/or replace its
|
|
101
|
+
* recipients (max 5). Enabling needs at least one recipient;
|
|
102
|
+
* clearing the recipients disables the cadence.
|
|
103
|
+
*/
|
|
104
|
+
setReportSchedule(frequency, body) {
|
|
105
|
+
return this.request("PATCH", `/reports/schedules/${frequency}`, { body });
|
|
106
|
+
}
|
|
77
107
|
/** Probe locations for monitor creation. */
|
|
78
108
|
locations() {
|
|
79
109
|
return this.request("GET", "/locations");
|
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,14 +182,9 @@ 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
190
|
/** Uptime % and response-time stats (maintenance excluded) */
|
|
@@ -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,12 +236,7 @@ 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 */
|
|
@@ -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,23 @@ 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
|
+
};
|
|
686
660
|
}
|
|
687
661
|
export type webhooks = Record<string, never>;
|
|
688
662
|
export interface components {
|
|
@@ -917,6 +891,109 @@ export interface components {
|
|
|
917
891
|
/** @default true */
|
|
918
892
|
excludeFromSla: boolean;
|
|
919
893
|
};
|
|
894
|
+
MaintenanceWindowUpdate: {
|
|
895
|
+
name?: string;
|
|
896
|
+
/** Format: date-time */
|
|
897
|
+
startsAt?: string;
|
|
898
|
+
durationMinutes?: number;
|
|
899
|
+
monitorIds?: string[];
|
|
900
|
+
monitorTags?: string[];
|
|
901
|
+
description?: string;
|
|
902
|
+
timezone?: string;
|
|
903
|
+
/** @enum {string} */
|
|
904
|
+
recurrence?: "once" | "daily" | "weekly" | "monthly";
|
|
905
|
+
};
|
|
906
|
+
AlertRuleUpdate: {
|
|
907
|
+
name?: string;
|
|
908
|
+
metric?: string;
|
|
909
|
+
operator?: string;
|
|
910
|
+
value?: string;
|
|
911
|
+
/** @enum {string} */
|
|
912
|
+
severity?: "critical" | "warning" | "info";
|
|
913
|
+
failureThreshold?: number;
|
|
914
|
+
minFailedProbes?: number;
|
|
915
|
+
/** @description Seconds */
|
|
916
|
+
durationWindow?: number;
|
|
917
|
+
enabled?: boolean;
|
|
918
|
+
};
|
|
919
|
+
ContactUpdate: {
|
|
920
|
+
name?: string;
|
|
921
|
+
/** Format: email */
|
|
922
|
+
email?: string;
|
|
923
|
+
phone?: string | null;
|
|
924
|
+
groupIds?: string[];
|
|
925
|
+
};
|
|
926
|
+
ContactGroupCreate: {
|
|
927
|
+
name: string;
|
|
928
|
+
contactIds?: string[];
|
|
929
|
+
};
|
|
930
|
+
ContactGroupUpdate: {
|
|
931
|
+
name?: string;
|
|
932
|
+
contactIds?: string[];
|
|
933
|
+
};
|
|
934
|
+
StatusPageCreate: {
|
|
935
|
+
slug: string;
|
|
936
|
+
name: string;
|
|
937
|
+
description?: string;
|
|
938
|
+
/** @default true */
|
|
939
|
+
isPublic: boolean;
|
|
940
|
+
password?: string | null;
|
|
941
|
+
/** @default true */
|
|
942
|
+
autoPublishIncidents: boolean;
|
|
943
|
+
/** @default false */
|
|
944
|
+
dimUntrackedDays: boolean;
|
|
945
|
+
logoPath?: string;
|
|
946
|
+
/**
|
|
947
|
+
* @default left
|
|
948
|
+
* @enum {string}
|
|
949
|
+
*/
|
|
950
|
+
logoPosition: "left" | "center" | "right";
|
|
951
|
+
/**
|
|
952
|
+
* @default auto
|
|
953
|
+
* @enum {string}
|
|
954
|
+
*/
|
|
955
|
+
theme: "light" | "dark" | "auto";
|
|
956
|
+
};
|
|
957
|
+
StatusPageUpdate: {
|
|
958
|
+
slug?: string;
|
|
959
|
+
name?: string;
|
|
960
|
+
description?: string | null;
|
|
961
|
+
isPublic?: boolean;
|
|
962
|
+
password?: string | null;
|
|
963
|
+
autoPublishIncidents?: boolean;
|
|
964
|
+
dimUntrackedDays?: boolean;
|
|
965
|
+
logoPath?: string | null;
|
|
966
|
+
/** @enum {string} */
|
|
967
|
+
logoPosition?: "left" | "center" | "right";
|
|
968
|
+
/** @enum {string} */
|
|
969
|
+
theme?: "light" | "dark" | "auto";
|
|
970
|
+
};
|
|
971
|
+
AnnouncementCreate: {
|
|
972
|
+
title: string;
|
|
973
|
+
body: string;
|
|
974
|
+
/**
|
|
975
|
+
* @default incident
|
|
976
|
+
* @enum {string}
|
|
977
|
+
*/
|
|
978
|
+
type: "incident" | "maintenance";
|
|
979
|
+
/**
|
|
980
|
+
* @default minor
|
|
981
|
+
* @enum {string}
|
|
982
|
+
*/
|
|
983
|
+
severity: "minor" | "major" | "critical";
|
|
984
|
+
affectedComponentIds?: string[];
|
|
985
|
+
affectedMonitorIds?: string[];
|
|
986
|
+
};
|
|
987
|
+
AnnouncementUpdate: {
|
|
988
|
+
title?: string;
|
|
989
|
+
body?: string;
|
|
990
|
+
/** @enum {string} */
|
|
991
|
+
type?: "incident" | "maintenance";
|
|
992
|
+
/** @enum {string} */
|
|
993
|
+
severity?: "minor" | "major" | "critical";
|
|
994
|
+
affectedComponentIds?: string[];
|
|
995
|
+
affectedMonitorIds?: string[];
|
|
996
|
+
};
|
|
920
997
|
Contact: {
|
|
921
998
|
/** Format: uuid */
|
|
922
999
|
id?: string;
|
|
@@ -1054,6 +1131,58 @@ export interface components {
|
|
|
1054
1131
|
/** Format: date-time */
|
|
1055
1132
|
created_at?: string;
|
|
1056
1133
|
};
|
|
1134
|
+
Ack: {
|
|
1135
|
+
object?: string;
|
|
1136
|
+
ok?: boolean;
|
|
1137
|
+
status?: string;
|
|
1138
|
+
message?: string;
|
|
1139
|
+
};
|
|
1140
|
+
/** @description Deletion confirmation (Stripe semantics): echoes the removed resource's id. */
|
|
1141
|
+
Deleted: {
|
|
1142
|
+
/** @constant */
|
|
1143
|
+
object: "deleted";
|
|
1144
|
+
id: string;
|
|
1145
|
+
/** @constant */
|
|
1146
|
+
deleted: true;
|
|
1147
|
+
};
|
|
1148
|
+
/** @description An OpenAPI 3.1 document describing this API. */
|
|
1149
|
+
OpenApiDocument: {
|
|
1150
|
+
openapi: string;
|
|
1151
|
+
info: Record<string, never>;
|
|
1152
|
+
paths: Record<string, never>;
|
|
1153
|
+
components?: Record<string, never>;
|
|
1154
|
+
};
|
|
1155
|
+
BatchResult: {
|
|
1156
|
+
/** @constant */
|
|
1157
|
+
object: "batch_result";
|
|
1158
|
+
results: {
|
|
1159
|
+
status: number;
|
|
1160
|
+
body?: Record<string, never>;
|
|
1161
|
+
}[];
|
|
1162
|
+
};
|
|
1163
|
+
Me: {
|
|
1164
|
+
/** @constant */
|
|
1165
|
+
object?: "api_key_identity";
|
|
1166
|
+
organization?: {
|
|
1167
|
+
/** Format: uuid */
|
|
1168
|
+
id?: string;
|
|
1169
|
+
name?: string;
|
|
1170
|
+
slug?: string;
|
|
1171
|
+
} | null;
|
|
1172
|
+
/** @enum {string} */
|
|
1173
|
+
scope?: "read" | "write";
|
|
1174
|
+
};
|
|
1175
|
+
MonitorType: {
|
|
1176
|
+
/** @constant */
|
|
1177
|
+
object?: "monitor_type";
|
|
1178
|
+
type?: string;
|
|
1179
|
+
label?: string;
|
|
1180
|
+
target_format?: string;
|
|
1181
|
+
target_example?: string;
|
|
1182
|
+
alert_metrics?: Record<string, never>[];
|
|
1183
|
+
config_fields?: Record<string, never>[];
|
|
1184
|
+
default_alert_rules?: Record<string, never>[];
|
|
1185
|
+
};
|
|
1057
1186
|
Summary: {
|
|
1058
1187
|
/** @constant */
|
|
1059
1188
|
object?: "summary";
|
|
@@ -1079,6 +1208,51 @@ export interface components {
|
|
|
1079
1208
|
counts?: Record<string, never>[];
|
|
1080
1209
|
top_unstable_monitors?: Record<string, never>[];
|
|
1081
1210
|
};
|
|
1211
|
+
/** @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 type-aware sections (listed in gated_sections) and truncates monitors. */
|
|
1212
|
+
Report: {
|
|
1213
|
+
/** @constant */
|
|
1214
|
+
object?: "report";
|
|
1215
|
+
meta?: {
|
|
1216
|
+
organizationId?: string;
|
|
1217
|
+
organizationName?: string;
|
|
1218
|
+
generatedAtMs?: number;
|
|
1219
|
+
period?: {
|
|
1220
|
+
fromMs?: number;
|
|
1221
|
+
toMs?: number;
|
|
1222
|
+
label?: string;
|
|
1223
|
+
};
|
|
1224
|
+
previousPeriod?: Record<string, never>;
|
|
1225
|
+
/** @enum {string} */
|
|
1226
|
+
depth?: "basic" | "advanced";
|
|
1227
|
+
typesPresent?: string[];
|
|
1228
|
+
};
|
|
1229
|
+
/** @description uptimePct/incidents/criticalIncidents/downtimeMs as compared values; mttrMs/mtbfMs nullable; longestIncident; totalChecks; monitorsCovered */
|
|
1230
|
+
summary?: Record<string, never>;
|
|
1231
|
+
/** @description Fleet avg/min/max ms + slow-check count over latency-style monitor types */
|
|
1232
|
+
responseTime?: Record<string, never> | null;
|
|
1233
|
+
/** @description Per-monitor rows, worst uptime first */
|
|
1234
|
+
monitors?: {
|
|
1235
|
+
monitorId?: string;
|
|
1236
|
+
name?: string;
|
|
1237
|
+
type?: string;
|
|
1238
|
+
uptimePct?: Record<string, never>;
|
|
1239
|
+
avgMs?: number;
|
|
1240
|
+
p95Ms?: number;
|
|
1241
|
+
incidents?: number;
|
|
1242
|
+
hadMaintenance?: boolean;
|
|
1243
|
+
}[];
|
|
1244
|
+
totalMonitors?: number;
|
|
1245
|
+
/** @description Type-aware sections keyed ssl/domains/cwv/heartbeat/blacklist/mcp — only for types the org monitors, advanced depth only */
|
|
1246
|
+
sections?: Record<string, never>;
|
|
1247
|
+
/** @description Sections that exist but are locked by the plan */
|
|
1248
|
+
gated_sections?: string[];
|
|
1249
|
+
/** @description Plain-language findings, most severe first, tone good|warning|critical|neutral */
|
|
1250
|
+
insights?: {
|
|
1251
|
+
tone?: string;
|
|
1252
|
+
text?: string;
|
|
1253
|
+
monitorId?: string;
|
|
1254
|
+
}[];
|
|
1255
|
+
};
|
|
1082
1256
|
OncallSchedule: {
|
|
1083
1257
|
id?: number;
|
|
1084
1258
|
/** @constant */
|
|
@@ -1093,6 +1267,94 @@ export interface components {
|
|
|
1093
1267
|
email?: string;
|
|
1094
1268
|
} | null;
|
|
1095
1269
|
};
|
|
1270
|
+
MonitorTypeList: {
|
|
1271
|
+
/** @constant */
|
|
1272
|
+
object: "list";
|
|
1273
|
+
data: components["schemas"]["MonitorType"][];
|
|
1274
|
+
has_more: boolean;
|
|
1275
|
+
};
|
|
1276
|
+
MonitorList: {
|
|
1277
|
+
/** @constant */
|
|
1278
|
+
object: "list";
|
|
1279
|
+
data: components["schemas"]["Monitor"][];
|
|
1280
|
+
has_more: boolean;
|
|
1281
|
+
next_cursor?: string | null;
|
|
1282
|
+
};
|
|
1283
|
+
CheckList: {
|
|
1284
|
+
/** @constant */
|
|
1285
|
+
object: "list";
|
|
1286
|
+
data: components["schemas"]["Check"][];
|
|
1287
|
+
has_more: boolean;
|
|
1288
|
+
locations?: Record<string, never>[];
|
|
1289
|
+
};
|
|
1290
|
+
AlertRuleList: {
|
|
1291
|
+
/** @constant */
|
|
1292
|
+
object: "list";
|
|
1293
|
+
data: components["schemas"]["AlertRule"][];
|
|
1294
|
+
has_more: boolean;
|
|
1295
|
+
};
|
|
1296
|
+
LocationList: {
|
|
1297
|
+
/** @constant */
|
|
1298
|
+
object: "list";
|
|
1299
|
+
data: components["schemas"]["Location"][];
|
|
1300
|
+
has_more: boolean;
|
|
1301
|
+
};
|
|
1302
|
+
IncidentList: {
|
|
1303
|
+
/** @constant */
|
|
1304
|
+
object: "list";
|
|
1305
|
+
data: components["schemas"]["Incident"][];
|
|
1306
|
+
has_more: boolean;
|
|
1307
|
+
total?: number;
|
|
1308
|
+
};
|
|
1309
|
+
MaintenanceWindowList: {
|
|
1310
|
+
/** @constant */
|
|
1311
|
+
object: "list";
|
|
1312
|
+
data: components["schemas"]["MaintenanceWindow"][];
|
|
1313
|
+
has_more: boolean;
|
|
1314
|
+
};
|
|
1315
|
+
ContactList: {
|
|
1316
|
+
/** @constant */
|
|
1317
|
+
object: "list";
|
|
1318
|
+
data: components["schemas"]["Contact"][];
|
|
1319
|
+
has_more: boolean;
|
|
1320
|
+
};
|
|
1321
|
+
ContactGroupList: {
|
|
1322
|
+
/** @constant */
|
|
1323
|
+
object: "list";
|
|
1324
|
+
data: components["schemas"]["ContactGroup"][];
|
|
1325
|
+
has_more: boolean;
|
|
1326
|
+
};
|
|
1327
|
+
StatusPageList: {
|
|
1328
|
+
/** @constant */
|
|
1329
|
+
object: "list";
|
|
1330
|
+
data: components["schemas"]["StatusPage"][];
|
|
1331
|
+
has_more: boolean;
|
|
1332
|
+
};
|
|
1333
|
+
AnnouncementList: {
|
|
1334
|
+
/** @constant */
|
|
1335
|
+
object: "list";
|
|
1336
|
+
data: components["schemas"]["Announcement"][];
|
|
1337
|
+
has_more: boolean;
|
|
1338
|
+
};
|
|
1339
|
+
OncallScheduleList: {
|
|
1340
|
+
/** @constant */
|
|
1341
|
+
object: "list";
|
|
1342
|
+
data: components["schemas"]["OncallSchedule"][];
|
|
1343
|
+
has_more: boolean;
|
|
1344
|
+
};
|
|
1345
|
+
NotificationList: {
|
|
1346
|
+
/** @constant */
|
|
1347
|
+
object: "list";
|
|
1348
|
+
data: components["schemas"]["Notification"][];
|
|
1349
|
+
has_more: boolean;
|
|
1350
|
+
total?: number;
|
|
1351
|
+
};
|
|
1352
|
+
ActivityEventList: {
|
|
1353
|
+
/** @constant */
|
|
1354
|
+
object: "list";
|
|
1355
|
+
data: components["schemas"]["ActivityEvent"][];
|
|
1356
|
+
has_more: boolean;
|
|
1357
|
+
};
|
|
1096
1358
|
};
|
|
1097
1359
|
responses: never;
|
|
1098
1360
|
parameters: never;
|
|
@@ -1116,7 +1378,9 @@ export interface operations {
|
|
|
1116
1378
|
headers: {
|
|
1117
1379
|
[name: string]: unknown;
|
|
1118
1380
|
};
|
|
1119
|
-
content
|
|
1381
|
+
content: {
|
|
1382
|
+
"application/json": components["schemas"]["Me"];
|
|
1383
|
+
};
|
|
1120
1384
|
};
|
|
1121
1385
|
};
|
|
1122
1386
|
};
|
|
@@ -1134,7 +1398,9 @@ export interface operations {
|
|
|
1134
1398
|
headers: {
|
|
1135
1399
|
[name: string]: unknown;
|
|
1136
1400
|
};
|
|
1137
|
-
content
|
|
1401
|
+
content: {
|
|
1402
|
+
"application/json": components["schemas"]["OpenApiDocument"];
|
|
1403
|
+
};
|
|
1138
1404
|
};
|
|
1139
1405
|
};
|
|
1140
1406
|
};
|
|
@@ -1152,7 +1418,50 @@ export interface operations {
|
|
|
1152
1418
|
headers: {
|
|
1153
1419
|
[name: string]: unknown;
|
|
1154
1420
|
};
|
|
1155
|
-
content
|
|
1421
|
+
content: {
|
|
1422
|
+
"application/json": components["schemas"]["MonitorTypeList"];
|
|
1423
|
+
};
|
|
1424
|
+
};
|
|
1425
|
+
};
|
|
1426
|
+
};
|
|
1427
|
+
batchOperations: {
|
|
1428
|
+
parameters: {
|
|
1429
|
+
query?: never;
|
|
1430
|
+
header?: never;
|
|
1431
|
+
path?: never;
|
|
1432
|
+
cookie?: never;
|
|
1433
|
+
};
|
|
1434
|
+
requestBody: {
|
|
1435
|
+
content: {
|
|
1436
|
+
"application/json": {
|
|
1437
|
+
operations: {
|
|
1438
|
+
/** @enum {string} */
|
|
1439
|
+
method: "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
|
|
1440
|
+
/** @description Relative /api/v1 sub-path, e.g. /monitors/{id} */
|
|
1441
|
+
path: string;
|
|
1442
|
+
body?: Record<string, never>;
|
|
1443
|
+
}[];
|
|
1444
|
+
};
|
|
1445
|
+
};
|
|
1446
|
+
};
|
|
1447
|
+
responses: {
|
|
1448
|
+
/** @description Per-operation results in request order */
|
|
1449
|
+
200: {
|
|
1450
|
+
headers: {
|
|
1451
|
+
[name: string]: unknown;
|
|
1452
|
+
};
|
|
1453
|
+
content: {
|
|
1454
|
+
"application/json": components["schemas"]["BatchResult"];
|
|
1455
|
+
};
|
|
1456
|
+
};
|
|
1457
|
+
/** @description Error */
|
|
1458
|
+
default: {
|
|
1459
|
+
headers: {
|
|
1460
|
+
[name: string]: unknown;
|
|
1461
|
+
};
|
|
1462
|
+
content: {
|
|
1463
|
+
"application/json": components["schemas"]["Error"];
|
|
1464
|
+
};
|
|
1156
1465
|
};
|
|
1157
1466
|
};
|
|
1158
1467
|
};
|
|
@@ -1179,13 +1488,7 @@ export interface operations {
|
|
|
1179
1488
|
[name: string]: unknown;
|
|
1180
1489
|
};
|
|
1181
1490
|
content: {
|
|
1182
|
-
"application/json":
|
|
1183
|
-
/** @constant */
|
|
1184
|
-
object?: "list";
|
|
1185
|
-
data?: components["schemas"]["Monitor"][];
|
|
1186
|
-
has_more?: boolean;
|
|
1187
|
-
next_cursor?: string | null;
|
|
1188
|
-
};
|
|
1491
|
+
"application/json": components["schemas"]["MonitorList"];
|
|
1189
1492
|
};
|
|
1190
1493
|
};
|
|
1191
1494
|
/** @description Error */
|
|
@@ -1319,12 +1622,14 @@ export interface operations {
|
|
|
1319
1622
|
};
|
|
1320
1623
|
requestBody?: never;
|
|
1321
1624
|
responses: {
|
|
1322
|
-
/** @description Deleted */
|
|
1323
|
-
|
|
1625
|
+
/** @description Deleted — returns a confirmation with the removed id */
|
|
1626
|
+
200: {
|
|
1324
1627
|
headers: {
|
|
1325
1628
|
[name: string]: unknown;
|
|
1326
1629
|
};
|
|
1327
|
-
content
|
|
1630
|
+
content: {
|
|
1631
|
+
"application/json": components["schemas"]["Deleted"];
|
|
1632
|
+
};
|
|
1328
1633
|
};
|
|
1329
1634
|
/** @description Error */
|
|
1330
1635
|
default: {
|
|
@@ -1458,12 +1763,14 @@ export interface operations {
|
|
|
1458
1763
|
};
|
|
1459
1764
|
requestBody?: never;
|
|
1460
1765
|
responses: {
|
|
1461
|
-
/** @description Check dispatched */
|
|
1766
|
+
/** @description Check dispatched (async) */
|
|
1462
1767
|
202: {
|
|
1463
1768
|
headers: {
|
|
1464
1769
|
[name: string]: unknown;
|
|
1465
1770
|
};
|
|
1466
|
-
content
|
|
1771
|
+
content: {
|
|
1772
|
+
"application/json": components["schemas"]["Ack"];
|
|
1773
|
+
};
|
|
1467
1774
|
};
|
|
1468
1775
|
/** @description Error */
|
|
1469
1776
|
default: {
|
|
@@ -1531,13 +1838,7 @@ export interface operations {
|
|
|
1531
1838
|
[name: string]: unknown;
|
|
1532
1839
|
};
|
|
1533
1840
|
content: {
|
|
1534
|
-
"application/json":
|
|
1535
|
-
/** @constant */
|
|
1536
|
-
object?: "list";
|
|
1537
|
-
data?: components["schemas"]["Check"][];
|
|
1538
|
-
has_more?: boolean;
|
|
1539
|
-
locations?: Record<string, never>[];
|
|
1540
|
-
};
|
|
1841
|
+
"application/json": components["schemas"]["CheckList"];
|
|
1541
1842
|
};
|
|
1542
1843
|
};
|
|
1543
1844
|
/** @description Error */
|
|
@@ -1569,12 +1870,7 @@ export interface operations {
|
|
|
1569
1870
|
[name: string]: unknown;
|
|
1570
1871
|
};
|
|
1571
1872
|
content: {
|
|
1572
|
-
"application/json":
|
|
1573
|
-
/** @constant */
|
|
1574
|
-
object?: "list";
|
|
1575
|
-
data?: components["schemas"]["AlertRule"][];
|
|
1576
|
-
has_more?: boolean;
|
|
1577
|
-
};
|
|
1873
|
+
"application/json": components["schemas"]["AlertRuleList"];
|
|
1578
1874
|
};
|
|
1579
1875
|
};
|
|
1580
1876
|
/** @description Error */
|
|
@@ -1675,12 +1971,14 @@ export interface operations {
|
|
|
1675
1971
|
};
|
|
1676
1972
|
requestBody?: never;
|
|
1677
1973
|
responses: {
|
|
1678
|
-
/** @description Deleted */
|
|
1679
|
-
|
|
1974
|
+
/** @description Deleted — returns a confirmation with the removed id */
|
|
1975
|
+
200: {
|
|
1680
1976
|
headers: {
|
|
1681
1977
|
[name: string]: unknown;
|
|
1682
1978
|
};
|
|
1683
|
-
content
|
|
1979
|
+
content: {
|
|
1980
|
+
"application/json": components["schemas"]["Deleted"];
|
|
1981
|
+
};
|
|
1684
1982
|
};
|
|
1685
1983
|
/** @description Error */
|
|
1686
1984
|
default: {
|
|
@@ -1705,7 +2003,11 @@ export interface operations {
|
|
|
1705
2003
|
};
|
|
1706
2004
|
cookie?: never;
|
|
1707
2005
|
};
|
|
1708
|
-
requestBody?:
|
|
2006
|
+
requestBody?: {
|
|
2007
|
+
content: {
|
|
2008
|
+
"application/json": components["schemas"]["AlertRuleUpdate"];
|
|
2009
|
+
};
|
|
2010
|
+
};
|
|
1709
2011
|
responses: {
|
|
1710
2012
|
/** @description OK */
|
|
1711
2013
|
200: {
|
|
@@ -1742,12 +2044,7 @@ export interface operations {
|
|
|
1742
2044
|
[name: string]: unknown;
|
|
1743
2045
|
};
|
|
1744
2046
|
content: {
|
|
1745
|
-
"application/json":
|
|
1746
|
-
/** @constant */
|
|
1747
|
-
object?: "list";
|
|
1748
|
-
data?: components["schemas"]["Location"][];
|
|
1749
|
-
has_more?: boolean;
|
|
1750
|
-
};
|
|
2047
|
+
"application/json": components["schemas"]["LocationList"];
|
|
1751
2048
|
};
|
|
1752
2049
|
};
|
|
1753
2050
|
/** @description Error */
|
|
@@ -1788,13 +2085,7 @@ export interface operations {
|
|
|
1788
2085
|
[name: string]: unknown;
|
|
1789
2086
|
};
|
|
1790
2087
|
content: {
|
|
1791
|
-
"application/json":
|
|
1792
|
-
/** @constant */
|
|
1793
|
-
object?: "list";
|
|
1794
|
-
data?: components["schemas"]["Incident"][];
|
|
1795
|
-
has_more?: boolean;
|
|
1796
|
-
total?: number;
|
|
1797
|
-
};
|
|
2088
|
+
"application/json": components["schemas"]["IncidentList"];
|
|
1798
2089
|
};
|
|
1799
2090
|
};
|
|
1800
2091
|
/** @description Error */
|
|
@@ -1934,12 +2225,14 @@ export interface operations {
|
|
|
1934
2225
|
};
|
|
1935
2226
|
requestBody?: never;
|
|
1936
2227
|
responses: {
|
|
1937
|
-
/** @description
|
|
2228
|
+
/** @description Incident marked as maintenance */
|
|
1938
2229
|
200: {
|
|
1939
2230
|
headers: {
|
|
1940
2231
|
[name: string]: unknown;
|
|
1941
2232
|
};
|
|
1942
|
-
content
|
|
2233
|
+
content: {
|
|
2234
|
+
"application/json": components["schemas"]["Incident"];
|
|
2235
|
+
};
|
|
1943
2236
|
};
|
|
1944
2237
|
/** @description Marked; returns the maintenance window */
|
|
1945
2238
|
201: {
|
|
@@ -1978,12 +2271,7 @@ export interface operations {
|
|
|
1978
2271
|
[name: string]: unknown;
|
|
1979
2272
|
};
|
|
1980
2273
|
content: {
|
|
1981
|
-
"application/json":
|
|
1982
|
-
/** @constant */
|
|
1983
|
-
object?: "list";
|
|
1984
|
-
data?: components["schemas"]["MaintenanceWindow"][];
|
|
1985
|
-
has_more?: boolean;
|
|
1986
|
-
};
|
|
2274
|
+
"application/json": components["schemas"]["MaintenanceWindowList"];
|
|
1987
2275
|
};
|
|
1988
2276
|
};
|
|
1989
2277
|
/** @description Error */
|
|
@@ -2077,12 +2365,14 @@ export interface operations {
|
|
|
2077
2365
|
};
|
|
2078
2366
|
requestBody?: never;
|
|
2079
2367
|
responses: {
|
|
2080
|
-
/** @description Deleted */
|
|
2081
|
-
|
|
2368
|
+
/** @description Deleted — returns a confirmation with the removed id */
|
|
2369
|
+
200: {
|
|
2082
2370
|
headers: {
|
|
2083
2371
|
[name: string]: unknown;
|
|
2084
2372
|
};
|
|
2085
|
-
content
|
|
2373
|
+
content: {
|
|
2374
|
+
"application/json": components["schemas"]["Deleted"];
|
|
2375
|
+
};
|
|
2086
2376
|
};
|
|
2087
2377
|
/** @description Error */
|
|
2088
2378
|
default: {
|
|
@@ -2105,7 +2395,11 @@ export interface operations {
|
|
|
2105
2395
|
};
|
|
2106
2396
|
cookie?: never;
|
|
2107
2397
|
};
|
|
2108
|
-
requestBody?:
|
|
2398
|
+
requestBody?: {
|
|
2399
|
+
content: {
|
|
2400
|
+
"application/json": components["schemas"]["MaintenanceWindowUpdate"];
|
|
2401
|
+
};
|
|
2402
|
+
};
|
|
2109
2403
|
responses: {
|
|
2110
2404
|
/** @description OK */
|
|
2111
2405
|
200: {
|
|
@@ -2146,12 +2440,7 @@ export interface operations {
|
|
|
2146
2440
|
[name: string]: unknown;
|
|
2147
2441
|
};
|
|
2148
2442
|
content: {
|
|
2149
|
-
"application/json":
|
|
2150
|
-
/** @constant */
|
|
2151
|
-
object?: "list";
|
|
2152
|
-
data?: components["schemas"]["Contact"][];
|
|
2153
|
-
has_more?: boolean;
|
|
2154
|
-
};
|
|
2443
|
+
"application/json": components["schemas"]["ContactList"];
|
|
2155
2444
|
};
|
|
2156
2445
|
};
|
|
2157
2446
|
/** @description Error */
|
|
@@ -2251,12 +2540,14 @@ export interface operations {
|
|
|
2251
2540
|
};
|
|
2252
2541
|
requestBody?: never;
|
|
2253
2542
|
responses: {
|
|
2254
|
-
/** @description Deleted */
|
|
2255
|
-
|
|
2543
|
+
/** @description Deleted — returns a confirmation with the removed id */
|
|
2544
|
+
200: {
|
|
2256
2545
|
headers: {
|
|
2257
2546
|
[name: string]: unknown;
|
|
2258
2547
|
};
|
|
2259
|
-
content
|
|
2548
|
+
content: {
|
|
2549
|
+
"application/json": components["schemas"]["Deleted"];
|
|
2550
|
+
};
|
|
2260
2551
|
};
|
|
2261
2552
|
/** @description Error */
|
|
2262
2553
|
default: {
|
|
@@ -2279,7 +2570,11 @@ export interface operations {
|
|
|
2279
2570
|
};
|
|
2280
2571
|
cookie?: never;
|
|
2281
2572
|
};
|
|
2282
|
-
requestBody?:
|
|
2573
|
+
requestBody?: {
|
|
2574
|
+
content: {
|
|
2575
|
+
"application/json": components["schemas"]["ContactUpdate"];
|
|
2576
|
+
};
|
|
2577
|
+
};
|
|
2283
2578
|
responses: {
|
|
2284
2579
|
/** @description OK */
|
|
2285
2580
|
200: {
|
|
@@ -2320,12 +2615,7 @@ export interface operations {
|
|
|
2320
2615
|
[name: string]: unknown;
|
|
2321
2616
|
};
|
|
2322
2617
|
content: {
|
|
2323
|
-
"application/json":
|
|
2324
|
-
/** @constant */
|
|
2325
|
-
object?: "list";
|
|
2326
|
-
data?: components["schemas"]["ContactGroup"][];
|
|
2327
|
-
has_more?: boolean;
|
|
2328
|
-
};
|
|
2618
|
+
"application/json": components["schemas"]["ContactGroupList"];
|
|
2329
2619
|
};
|
|
2330
2620
|
};
|
|
2331
2621
|
/** @description Error */
|
|
@@ -2349,7 +2639,11 @@ export interface operations {
|
|
|
2349
2639
|
path?: never;
|
|
2350
2640
|
cookie?: never;
|
|
2351
2641
|
};
|
|
2352
|
-
requestBody
|
|
2642
|
+
requestBody: {
|
|
2643
|
+
content: {
|
|
2644
|
+
"application/json": components["schemas"]["ContactGroupCreate"];
|
|
2645
|
+
};
|
|
2646
|
+
};
|
|
2353
2647
|
responses: {
|
|
2354
2648
|
/** @description Created */
|
|
2355
2649
|
201: {
|
|
@@ -2415,12 +2709,14 @@ export interface operations {
|
|
|
2415
2709
|
};
|
|
2416
2710
|
requestBody?: never;
|
|
2417
2711
|
responses: {
|
|
2418
|
-
/** @description Deleted */
|
|
2419
|
-
|
|
2712
|
+
/** @description Deleted — returns a confirmation with the removed id */
|
|
2713
|
+
200: {
|
|
2420
2714
|
headers: {
|
|
2421
2715
|
[name: string]: unknown;
|
|
2422
2716
|
};
|
|
2423
|
-
content
|
|
2717
|
+
content: {
|
|
2718
|
+
"application/json": components["schemas"]["Deleted"];
|
|
2719
|
+
};
|
|
2424
2720
|
};
|
|
2425
2721
|
/** @description Error */
|
|
2426
2722
|
default: {
|
|
@@ -2443,7 +2739,11 @@ export interface operations {
|
|
|
2443
2739
|
};
|
|
2444
2740
|
cookie?: never;
|
|
2445
2741
|
};
|
|
2446
|
-
requestBody?:
|
|
2742
|
+
requestBody?: {
|
|
2743
|
+
content: {
|
|
2744
|
+
"application/json": components["schemas"]["ContactGroupUpdate"];
|
|
2745
|
+
};
|
|
2746
|
+
};
|
|
2447
2747
|
responses: {
|
|
2448
2748
|
/** @description OK */
|
|
2449
2749
|
200: {
|
|
@@ -2480,12 +2780,7 @@ export interface operations {
|
|
|
2480
2780
|
[name: string]: unknown;
|
|
2481
2781
|
};
|
|
2482
2782
|
content: {
|
|
2483
|
-
"application/json":
|
|
2484
|
-
/** @constant */
|
|
2485
|
-
object?: "list";
|
|
2486
|
-
data?: components["schemas"]["StatusPage"][];
|
|
2487
|
-
has_more?: boolean;
|
|
2488
|
-
};
|
|
2783
|
+
"application/json": components["schemas"]["StatusPageList"];
|
|
2489
2784
|
};
|
|
2490
2785
|
};
|
|
2491
2786
|
/** @description Error */
|
|
@@ -2509,7 +2804,11 @@ export interface operations {
|
|
|
2509
2804
|
path?: never;
|
|
2510
2805
|
cookie?: never;
|
|
2511
2806
|
};
|
|
2512
|
-
requestBody
|
|
2807
|
+
requestBody: {
|
|
2808
|
+
content: {
|
|
2809
|
+
"application/json": components["schemas"]["StatusPageCreate"];
|
|
2810
|
+
};
|
|
2811
|
+
};
|
|
2513
2812
|
responses: {
|
|
2514
2813
|
/** @description Created */
|
|
2515
2814
|
201: {
|
|
@@ -2575,12 +2874,14 @@ export interface operations {
|
|
|
2575
2874
|
};
|
|
2576
2875
|
requestBody?: never;
|
|
2577
2876
|
responses: {
|
|
2578
|
-
/** @description Deleted */
|
|
2579
|
-
|
|
2877
|
+
/** @description Deleted — returns a confirmation with the removed id */
|
|
2878
|
+
200: {
|
|
2580
2879
|
headers: {
|
|
2581
2880
|
[name: string]: unknown;
|
|
2582
2881
|
};
|
|
2583
|
-
content
|
|
2882
|
+
content: {
|
|
2883
|
+
"application/json": components["schemas"]["Deleted"];
|
|
2884
|
+
};
|
|
2584
2885
|
};
|
|
2585
2886
|
/** @description Error */
|
|
2586
2887
|
default: {
|
|
@@ -2603,7 +2904,11 @@ export interface operations {
|
|
|
2603
2904
|
};
|
|
2604
2905
|
cookie?: never;
|
|
2605
2906
|
};
|
|
2606
|
-
requestBody?:
|
|
2907
|
+
requestBody?: {
|
|
2908
|
+
content: {
|
|
2909
|
+
"application/json": components["schemas"]["StatusPageUpdate"];
|
|
2910
|
+
};
|
|
2911
|
+
};
|
|
2607
2912
|
responses: {
|
|
2608
2913
|
/** @description OK */
|
|
2609
2914
|
200: {
|
|
@@ -2643,12 +2948,7 @@ export interface operations {
|
|
|
2643
2948
|
[name: string]: unknown;
|
|
2644
2949
|
};
|
|
2645
2950
|
content: {
|
|
2646
|
-
"application/json":
|
|
2647
|
-
/** @constant */
|
|
2648
|
-
object?: "list";
|
|
2649
|
-
data?: components["schemas"]["Announcement"][];
|
|
2650
|
-
has_more?: boolean;
|
|
2651
|
-
};
|
|
2951
|
+
"application/json": components["schemas"]["AnnouncementList"];
|
|
2652
2952
|
};
|
|
2653
2953
|
};
|
|
2654
2954
|
/** @description Error */
|
|
@@ -2675,7 +2975,11 @@ export interface operations {
|
|
|
2675
2975
|
};
|
|
2676
2976
|
cookie?: never;
|
|
2677
2977
|
};
|
|
2678
|
-
requestBody
|
|
2978
|
+
requestBody: {
|
|
2979
|
+
content: {
|
|
2980
|
+
"application/json": components["schemas"]["AnnouncementCreate"];
|
|
2981
|
+
};
|
|
2982
|
+
};
|
|
2679
2983
|
responses: {
|
|
2680
2984
|
/** @description Created */
|
|
2681
2985
|
201: {
|
|
@@ -2745,12 +3049,14 @@ export interface operations {
|
|
|
2745
3049
|
};
|
|
2746
3050
|
requestBody?: never;
|
|
2747
3051
|
responses: {
|
|
2748
|
-
/** @description Deleted */
|
|
2749
|
-
|
|
3052
|
+
/** @description Deleted — returns a confirmation with the removed id */
|
|
3053
|
+
200: {
|
|
2750
3054
|
headers: {
|
|
2751
3055
|
[name: string]: unknown;
|
|
2752
3056
|
};
|
|
2753
|
-
content
|
|
3057
|
+
content: {
|
|
3058
|
+
"application/json": components["schemas"]["Deleted"];
|
|
3059
|
+
};
|
|
2754
3060
|
};
|
|
2755
3061
|
/** @description Error */
|
|
2756
3062
|
default: {
|
|
@@ -2775,7 +3081,11 @@ export interface operations {
|
|
|
2775
3081
|
};
|
|
2776
3082
|
cookie?: never;
|
|
2777
3083
|
};
|
|
2778
|
-
requestBody?:
|
|
3084
|
+
requestBody?: {
|
|
3085
|
+
content: {
|
|
3086
|
+
"application/json": components["schemas"]["AnnouncementUpdate"];
|
|
3087
|
+
};
|
|
3088
|
+
};
|
|
2779
3089
|
responses: {
|
|
2780
3090
|
/** @description OK */
|
|
2781
3091
|
200: {
|
|
@@ -2841,12 +3151,7 @@ export interface operations {
|
|
|
2841
3151
|
[name: string]: unknown;
|
|
2842
3152
|
};
|
|
2843
3153
|
content: {
|
|
2844
|
-
"application/json":
|
|
2845
|
-
/** @constant */
|
|
2846
|
-
object?: "list";
|
|
2847
|
-
data?: components["schemas"]["OncallSchedule"][];
|
|
2848
|
-
has_more?: boolean;
|
|
2849
|
-
};
|
|
3154
|
+
"application/json": components["schemas"]["OncallScheduleList"];
|
|
2850
3155
|
};
|
|
2851
3156
|
};
|
|
2852
3157
|
/** @description Error */
|
|
@@ -2885,13 +3190,7 @@ export interface operations {
|
|
|
2885
3190
|
[name: string]: unknown;
|
|
2886
3191
|
};
|
|
2887
3192
|
content: {
|
|
2888
|
-
"application/json":
|
|
2889
|
-
/** @constant */
|
|
2890
|
-
object?: "list";
|
|
2891
|
-
data?: components["schemas"]["Notification"][];
|
|
2892
|
-
has_more?: boolean;
|
|
2893
|
-
total?: number;
|
|
2894
|
-
};
|
|
3193
|
+
"application/json": components["schemas"]["NotificationList"];
|
|
2895
3194
|
};
|
|
2896
3195
|
};
|
|
2897
3196
|
/** @description Error */
|
|
@@ -2930,12 +3229,7 @@ export interface operations {
|
|
|
2930
3229
|
[name: string]: unknown;
|
|
2931
3230
|
};
|
|
2932
3231
|
content: {
|
|
2933
|
-
"application/json":
|
|
2934
|
-
/** @constant */
|
|
2935
|
-
object?: "list";
|
|
2936
|
-
data?: components["schemas"]["ActivityEvent"][];
|
|
2937
|
-
has_more?: boolean;
|
|
2938
|
-
};
|
|
3232
|
+
"application/json": components["schemas"]["ActivityEventList"];
|
|
2939
3233
|
};
|
|
2940
3234
|
};
|
|
2941
3235
|
/** @description Error */
|
|
@@ -3009,4 +3303,40 @@ export interface operations {
|
|
|
3009
3303
|
};
|
|
3010
3304
|
};
|
|
3011
3305
|
};
|
|
3306
|
+
getReport: {
|
|
3307
|
+
parameters: {
|
|
3308
|
+
query?: {
|
|
3309
|
+
/** @description Preset trailing window (ignored when from/to given) */
|
|
3310
|
+
period?: "7d" | "30d";
|
|
3311
|
+
/** @description Custom period start (ISO 8601 or Unix epoch). Needs the advanced-reports plan capability; max 92 days. */
|
|
3312
|
+
from?: string;
|
|
3313
|
+
/** @description Custom period end (ISO 8601 or Unix epoch) */
|
|
3314
|
+
to?: string;
|
|
3315
|
+
};
|
|
3316
|
+
header?: never;
|
|
3317
|
+
path?: never;
|
|
3318
|
+
cookie?: never;
|
|
3319
|
+
};
|
|
3320
|
+
requestBody?: never;
|
|
3321
|
+
responses: {
|
|
3322
|
+
/** @description OK */
|
|
3323
|
+
200: {
|
|
3324
|
+
headers: {
|
|
3325
|
+
[name: string]: unknown;
|
|
3326
|
+
};
|
|
3327
|
+
content: {
|
|
3328
|
+
"application/json": components["schemas"]["Report"];
|
|
3329
|
+
};
|
|
3330
|
+
};
|
|
3331
|
+
/** @description Error */
|
|
3332
|
+
default: {
|
|
3333
|
+
headers: {
|
|
3334
|
+
[name: string]: unknown;
|
|
3335
|
+
};
|
|
3336
|
+
content: {
|
|
3337
|
+
"application/json": components["schemas"]["Error"];
|
|
3338
|
+
};
|
|
3339
|
+
};
|
|
3340
|
+
};
|
|
3341
|
+
};
|
|
3012
3342
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "watchfor",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "Official TypeScript SDK + CLI for WatchFor
|
|
3
|
+
"version": "0.3.0",
|
|
4
|
+
"description": "Official TypeScript SDK + CLI for WatchFor \u2014 uptime & infrastructure monitoring (monitors, alert rules, incidents, maintenance windows) over the REST API.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"watchfor",
|
|
7
7
|
"monitoring",
|