@leaflow/sdk 0.0.0-dev.113.g5d6fb99 → 0.0.0-dev.113.gecc0f27
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 +34 -0
- package/dist/account/v1/index.d.ts +16 -0
- package/dist/account/v1/schema.d.ts +294 -3
- package/dist/assistant/v1/index.d.ts +74 -34
- package/dist/assistant/v1/schema.d.ts +1113 -157
- package/dist/billing/v1/index.d.ts +70 -0
- package/dist/billing/v1/index.js +5 -0
- package/dist/billing/v1/schema.d.ts +2657 -0
- package/dist/canopy/v1/index.d.ts +12 -0
- package/dist/compute/v1/index.d.ts +50 -4
- package/dist/compute/v1/schema.d.ts +857 -268
- package/dist/dns/v1/index.d.ts +42 -0
- package/dist/dns/v1/index.js +5 -0
- package/dist/dns/v1/schema.d.ts +883 -0
- package/dist/iam/v1/index.d.ts +28 -0
- package/dist/iam/v1/schema.d.ts +437 -9
- package/dist/index.d.ts +4 -0
- package/dist/monitoring/v1/index.d.ts +96 -0
- package/dist/monitoring/v1/schema.d.ts +2386 -496
- package/dist/notification/v1/index.d.ts +76 -0
- package/dist/notification/v1/index.js +5 -0
- package/dist/notification/v1/schema.d.ts +2044 -0
- package/dist/support/v1/index.d.ts +50 -0
- package/dist/support/v1/index.js +5 -0
- package/dist/support/v1/schema.d.ts +1078 -0
- package/dist/tunnel/v1/index.d.ts +14 -32
- package/dist/tunnel/v1/schema.d.ts +52 -496
- package/package.json +5 -4
- package/dist/gen/account/v1/schema.d.ts +0 -866
- package/dist/gen/assistant/v1/schema.d.ts +0 -1884
- package/dist/gen/canopy/v1/schema.d.ts +0 -1100
- package/dist/gen/compute/v1/schema.d.ts +0 -4439
- package/dist/gen/iam/v1/schema.d.ts +0 -1230
- package/dist/gen/iam/v1/schema.js +0 -5
- package/dist/gen/monitoring/v1/schema.d.ts +0 -2291
- package/dist/gen/monitoring/v1/schema.js +0 -5
- package/dist/gen/tunnel/v1/schema.d.ts +0 -845
- package/dist/gen/tunnel/v1/schema.js +0 -5
- package/dist/src/client.d.ts +0 -57
- package/dist/src/client.js +0 -41
- package/dist/src/index.d.ts +0 -9
- package/dist/src/index.js +0 -1
- /package/dist/{gen/account → billing}/v1/schema.js +0 -0
- /package/dist/{gen/assistant → dns}/v1/schema.js +0 -0
- /package/dist/{gen/canopy → notification}/v1/schema.js +0 -0
- /package/dist/{gen/compute → support}/v1/schema.js +0 -0
|
@@ -11,8 +11,8 @@ export interface paths {
|
|
|
11
11
|
cookie?: never;
|
|
12
12
|
};
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
15
|
-
* @description `incident_status`
|
|
14
|
+
* List incidents
|
|
15
|
+
* @description `incident_status` reports whether monitoring considers the problem recovered; `closed` reports whether someone has finished handling it. The two are independent and can be filtered separately.
|
|
16
16
|
*/
|
|
17
17
|
get: operations["list-incidents"];
|
|
18
18
|
put?: never;
|
|
@@ -30,7 +30,7 @@ export interface paths {
|
|
|
30
30
|
path?: never;
|
|
31
31
|
cookie?: never;
|
|
32
32
|
};
|
|
33
|
-
/**
|
|
33
|
+
/** Get an incident */
|
|
34
34
|
get: operations["get-incident"];
|
|
35
35
|
put?: never;
|
|
36
36
|
post?: never;
|
|
@@ -50,8 +50,8 @@ export interface paths {
|
|
|
50
50
|
get?: never;
|
|
51
51
|
put?: never;
|
|
52
52
|
/**
|
|
53
|
-
*
|
|
54
|
-
* @description
|
|
53
|
+
* Acknowledge an incident
|
|
54
|
+
* @description The incident is also marked as acknowledged in the monitoring system, so that other channels can see it already has an owner.
|
|
55
55
|
*/
|
|
56
56
|
post: operations["acknowledge-incident"];
|
|
57
57
|
delete?: never;
|
|
@@ -69,10 +69,10 @@ export interface paths {
|
|
|
69
69
|
};
|
|
70
70
|
get?: never;
|
|
71
71
|
/**
|
|
72
|
-
*
|
|
73
|
-
* @description `assignee_user_id`
|
|
72
|
+
* Assign an incident, or clear its assignee
|
|
73
|
+
* @description Leave `assignee_user_id` empty to clear the assignment.
|
|
74
74
|
*
|
|
75
|
-
*
|
|
75
|
+
* **Project membership of the assignee is not verified.** Any user identifier is accepted and recorded as given.
|
|
76
76
|
*/
|
|
77
77
|
put: operations["assign-incident"];
|
|
78
78
|
post?: never;
|
|
@@ -92,8 +92,8 @@ export interface paths {
|
|
|
92
92
|
get?: never;
|
|
93
93
|
put?: never;
|
|
94
94
|
/**
|
|
95
|
-
*
|
|
96
|
-
* @description
|
|
95
|
+
* Close an incident
|
|
96
|
+
* @description Closing records **that the handling process is finished on this platform**; it does not change the state of the incident itself. An incident that has not recovered may still be closed as an accepted risk, and remains unrecovered in the monitoring system.
|
|
97
97
|
*/
|
|
98
98
|
post: operations["close-incident"];
|
|
99
99
|
delete?: never;
|
|
@@ -111,7 +111,7 @@ export interface paths {
|
|
|
111
111
|
};
|
|
112
112
|
get?: never;
|
|
113
113
|
put?: never;
|
|
114
|
-
/**
|
|
114
|
+
/** Add a note to the timeline */
|
|
115
115
|
post: operations["add-incident-comment"];
|
|
116
116
|
delete?: never;
|
|
117
117
|
options?: never;
|
|
@@ -128,8 +128,8 @@ export interface paths {
|
|
|
128
128
|
};
|
|
129
129
|
get?: never;
|
|
130
130
|
/**
|
|
131
|
-
*
|
|
132
|
-
* @description
|
|
131
|
+
* Follow an incident, or stop following it
|
|
132
|
+
* @description You follow **yourself**: the caller is the user added to or removed from the follower list.
|
|
133
133
|
*/
|
|
134
134
|
put: operations["set-incident-following"];
|
|
135
135
|
post?: never;
|
|
@@ -148,7 +148,7 @@ export interface paths {
|
|
|
148
148
|
};
|
|
149
149
|
get?: never;
|
|
150
150
|
put?: never;
|
|
151
|
-
/**
|
|
151
|
+
/** Reopen a closed incident */
|
|
152
152
|
post: operations["reopen-incident"];
|
|
153
153
|
delete?: never;
|
|
154
154
|
options?: never;
|
|
@@ -164,8 +164,8 @@ export interface paths {
|
|
|
164
164
|
cookie?: never;
|
|
165
165
|
};
|
|
166
166
|
/**
|
|
167
|
-
*
|
|
168
|
-
* @description
|
|
167
|
+
* List the timeline of an incident
|
|
168
|
+
* @description Cursor paging rather than offset paging: the timeline is append-only, and offset paging would skip or repeat entries whenever a new one is written.
|
|
169
169
|
*/
|
|
170
170
|
get: operations["list-incident-timeline"];
|
|
171
171
|
put?: never;
|
|
@@ -183,7 +183,7 @@ export interface paths {
|
|
|
183
183
|
path?: never;
|
|
184
184
|
cookie?: never;
|
|
185
185
|
};
|
|
186
|
-
/**
|
|
186
|
+
/** List maintenance windows */
|
|
187
187
|
get: operations["list-maintenance-windows"];
|
|
188
188
|
put?: never;
|
|
189
189
|
post?: never;
|
|
@@ -200,19 +200,19 @@ export interface paths {
|
|
|
200
200
|
path?: never;
|
|
201
201
|
cookie?: never;
|
|
202
202
|
};
|
|
203
|
-
/**
|
|
203
|
+
/** Get a maintenance window */
|
|
204
204
|
get: operations["get-maintenance-window"];
|
|
205
205
|
/**
|
|
206
|
-
*
|
|
207
|
-
* @description
|
|
206
|
+
* Create a maintenance window, or replace it by the same id
|
|
207
|
+
* @description **Create or replace**: extending a window that is already running means calling this endpoint again with the same id.
|
|
208
208
|
*
|
|
209
|
-
*
|
|
209
|
+
* While the window is open, problems on these machines do not alert and do not count against SLA availability. Leave `server_ids` empty to cover the entire project, including machines enrolled after the window opens.
|
|
210
210
|
*/
|
|
211
211
|
put: operations["put-maintenance-window"];
|
|
212
212
|
post?: never;
|
|
213
213
|
/**
|
|
214
|
-
*
|
|
215
|
-
* @description
|
|
214
|
+
* Cancel a maintenance window
|
|
215
|
+
* @description Alerting resumes immediately, even if the window has not yet expired.
|
|
216
216
|
*/
|
|
217
217
|
delete: operations["delete-maintenance-window"];
|
|
218
218
|
options?: never;
|
|
@@ -228,8 +228,8 @@ export interface paths {
|
|
|
228
228
|
cookie?: never;
|
|
229
229
|
};
|
|
230
230
|
/**
|
|
231
|
-
*
|
|
232
|
-
* @description
|
|
231
|
+
* Project overview
|
|
232
|
+
* @description A project with no machines yet returns an overview with every figure at zero rather than a 404 — an empty project is a normal state.
|
|
233
233
|
*/
|
|
234
234
|
get: operations["get-project-overview"];
|
|
235
235
|
put?: never;
|
|
@@ -248,8 +248,8 @@ export interface paths {
|
|
|
248
248
|
cookie?: never;
|
|
249
249
|
};
|
|
250
250
|
/**
|
|
251
|
-
*
|
|
252
|
-
* @description
|
|
251
|
+
* List the monitoring items of a machine
|
|
252
|
+
* @description Items are returned exactly as collected, without filtering or renaming. Which of them count as important is for the caller to decide from the tags carried by each item.
|
|
253
253
|
*/
|
|
254
254
|
get: operations["list-server-items"];
|
|
255
255
|
put?: never;
|
|
@@ -268,8 +268,8 @@ export interface paths {
|
|
|
268
268
|
cookie?: never;
|
|
269
269
|
};
|
|
270
270
|
/**
|
|
271
|
-
*
|
|
272
|
-
* @description `item_key`
|
|
271
|
+
* Get the time series of a monitoring item
|
|
272
|
+
* @description `item_key` is matched **by prefix**. Keys discovered per partition or per interface carry parameters (`vfs.fs.size[/var,pused]`), so a single request for `vfs.fs.size` returns one series per mount point.
|
|
273
273
|
*/
|
|
274
274
|
get: operations["get-server-metric"];
|
|
275
275
|
put?: never;
|
|
@@ -287,7 +287,7 @@ export interface paths {
|
|
|
287
287
|
path?: never;
|
|
288
288
|
cookie?: never;
|
|
289
289
|
};
|
|
290
|
-
/**
|
|
290
|
+
/** Hardware and interfaces of a machine */
|
|
291
291
|
get: operations["get-server-resources"];
|
|
292
292
|
put?: never;
|
|
293
293
|
post?: never;
|
|
@@ -304,7 +304,7 @@ export interface paths {
|
|
|
304
304
|
path?: never;
|
|
305
305
|
cookie?: never;
|
|
306
306
|
};
|
|
307
|
-
/**
|
|
307
|
+
/** Current state of a machine */
|
|
308
308
|
get: operations["get-server-snapshot"];
|
|
309
309
|
put?: never;
|
|
310
310
|
post?: never;
|
|
@@ -321,7 +321,7 @@ export interface paths {
|
|
|
321
321
|
path?: never;
|
|
322
322
|
cookie?: never;
|
|
323
323
|
};
|
|
324
|
-
/**
|
|
324
|
+
/** Machines ranked highest by a given metric */
|
|
325
325
|
get: operations["list-project-top-items"];
|
|
326
326
|
put?: never;
|
|
327
327
|
post?: never;
|
|
@@ -331,6 +331,26 @@ export interface paths {
|
|
|
331
331
|
patch?: never;
|
|
332
332
|
trace?: never;
|
|
333
333
|
};
|
|
334
|
+
"/api/v1/templates": {
|
|
335
|
+
parameters: {
|
|
336
|
+
query?: never;
|
|
337
|
+
header?: never;
|
|
338
|
+
path?: never;
|
|
339
|
+
cookie?: never;
|
|
340
|
+
};
|
|
341
|
+
/**
|
|
342
|
+
* List the monitoring templates that can be bound to a machine
|
|
343
|
+
* @description The catalog every template binding is validated against — which templates exist, which parameters each of them accepts, and what each parameter defaults to. It is identical for every project and changes only when this deployment is upgraded. Read it rather than keeping a copy. A copy drifts, and only one of the ways it drifts fails loudly — an unknown parameter name is rejected, but a stale `default` and a stale `required` both look correct on screen.
|
|
344
|
+
*/
|
|
345
|
+
get: operations["list-templates"];
|
|
346
|
+
put?: never;
|
|
347
|
+
post?: never;
|
|
348
|
+
delete?: never;
|
|
349
|
+
options?: never;
|
|
350
|
+
head?: never;
|
|
351
|
+
patch?: never;
|
|
352
|
+
trace?: never;
|
|
353
|
+
};
|
|
334
354
|
"/api/v1/servers": {
|
|
335
355
|
parameters: {
|
|
336
356
|
query?: never;
|
|
@@ -338,7 +358,7 @@ export interface paths {
|
|
|
338
358
|
path?: never;
|
|
339
359
|
cookie?: never;
|
|
340
360
|
};
|
|
341
|
-
/**
|
|
361
|
+
/** List the machines in the project */
|
|
342
362
|
get: operations["list-servers"];
|
|
343
363
|
put?: never;
|
|
344
364
|
post?: never;
|
|
@@ -355,28 +375,32 @@ export interface paths {
|
|
|
355
375
|
path?: never;
|
|
356
376
|
cookie?: never;
|
|
357
377
|
};
|
|
358
|
-
/**
|
|
378
|
+
/** Get the enrollment state of a machine */
|
|
359
379
|
get: operations["get-server"];
|
|
360
380
|
/**
|
|
361
|
-
*
|
|
362
|
-
* @description
|
|
381
|
+
* Enroll a machine into monitoring
|
|
382
|
+
* @description **Repeated calls with the same server id are idempotent**: given identical parameters, the already-enrolled machine is returned and no duplicate host is created, so a failed enrollment is safe to retry.
|
|
363
383
|
*
|
|
364
|
-
*
|
|
384
|
+
* To change enrollment settings, use PATCH. This endpoint returns an error when the parameters differ, and does not update an existing configuration.
|
|
365
385
|
*
|
|
366
|
-
*
|
|
386
|
+
* A failed call leaves the machine recorded with `monitoring_status: FAILED`; the reason is reported in `last_error` via `GET /servers/{serverId}`.
|
|
387
|
+
*
|
|
388
|
+
* The `tls_psk` in the response is **returned only this once**; store it immediately. If it is lost, it must be rotated.
|
|
389
|
+
*
|
|
390
|
+
* It is also how collection is resumed after `/disable`. On a machine that already exists, **omitting `template_bindings` keeps the bindings it already has**; it does not fall back to the default of Linux alone, which would silently drop every other template together with its parameters. Secret parameters are likewise carried over — see `parameters` on the binding.
|
|
367
391
|
*/
|
|
368
392
|
put: operations["enable-server-monitoring"];
|
|
369
393
|
post?: never;
|
|
370
394
|
/**
|
|
371
|
-
*
|
|
372
|
-
* @description
|
|
395
|
+
* Delete a machine
|
|
396
|
+
* @description **Irreversible**: the monitored host, its history and every incident recorded against this machine are removed together. To stop collection temporarily, use `/disable` instead.
|
|
373
397
|
*/
|
|
374
398
|
delete: operations["delete-server"];
|
|
375
399
|
options?: never;
|
|
376
400
|
head?: never;
|
|
377
401
|
/**
|
|
378
|
-
*
|
|
379
|
-
* @description
|
|
402
|
+
* Update the enrollment settings of a machine
|
|
403
|
+
* @description Only the fields present in the request body are updated. `address` and `address_kind` must be supplied together: changing one without the other produces a contradictory configuration that is not reported as an error and shows up only as an agent that cannot connect.
|
|
380
404
|
*/
|
|
381
405
|
patch: operations["update-server"];
|
|
382
406
|
trace?: never;
|
|
@@ -391,8 +415,8 @@ export interface paths {
|
|
|
391
415
|
get?: never;
|
|
392
416
|
put?: never;
|
|
393
417
|
/**
|
|
394
|
-
*
|
|
395
|
-
* @description
|
|
418
|
+
* Stop monitoring a machine
|
|
419
|
+
* @description Reversible: the monitored host is retained, only collection stops, and history is unaffected. Enrolling again resumes collection. To remove the history as well, use DELETE.
|
|
396
420
|
*/
|
|
397
421
|
post: operations["disable-server-monitoring"];
|
|
398
422
|
delete?: never;
|
|
@@ -411,8 +435,8 @@ export interface paths {
|
|
|
411
435
|
get?: never;
|
|
412
436
|
put?: never;
|
|
413
437
|
/**
|
|
414
|
-
*
|
|
415
|
-
* @description
|
|
438
|
+
* Rotate the agent PSK
|
|
439
|
+
* @description The agent configuration must be updated to match, otherwise the machine loses contact immediately. The new key is likewise **returned in clear text only in this response**.
|
|
416
440
|
*/
|
|
417
441
|
post: operations["rotate-agent-psk"];
|
|
418
442
|
delete?: never;
|
|
@@ -428,17 +452,17 @@ export interface paths {
|
|
|
428
452
|
path?: never;
|
|
429
453
|
cookie?: never;
|
|
430
454
|
};
|
|
431
|
-
/**
|
|
455
|
+
/** Get a web check */
|
|
432
456
|
get: operations["get-web-check"];
|
|
433
457
|
/**
|
|
434
|
-
*
|
|
435
|
-
* @description
|
|
458
|
+
* Create a web check, or replace it by the same id
|
|
459
|
+
* @description **Create or replace**: to modify a check, call this endpoint again with the same id. There is no need to determine first whether it already exists.
|
|
436
460
|
*/
|
|
437
461
|
put: operations["put-web-check"];
|
|
438
462
|
post?: never;
|
|
439
463
|
/**
|
|
440
|
-
*
|
|
441
|
-
* @description
|
|
464
|
+
* Delete a web check
|
|
465
|
+
* @description The corresponding check task and trigger are removed from the monitoring system as well, so no permanently unrecoverable alert is left behind.
|
|
442
466
|
*/
|
|
443
467
|
delete: operations["delete-web-check"];
|
|
444
468
|
options?: never;
|
|
@@ -453,7 +477,7 @@ export interface paths {
|
|
|
453
477
|
path?: never;
|
|
454
478
|
cookie?: never;
|
|
455
479
|
};
|
|
456
|
-
/**
|
|
480
|
+
/** List web checks */
|
|
457
481
|
get: operations["list-web-checks"];
|
|
458
482
|
put?: never;
|
|
459
483
|
post?: never;
|
|
@@ -471,10 +495,10 @@ export interface paths {
|
|
|
471
495
|
cookie?: never;
|
|
472
496
|
};
|
|
473
497
|
/**
|
|
474
|
-
*
|
|
475
|
-
* @description SLI
|
|
498
|
+
* Get measured availability
|
|
499
|
+
* @description SLI is what was measured; SLO is what was promised — this endpoint returns the former.
|
|
476
500
|
*
|
|
477
|
-
* `server_id`
|
|
501
|
+
* The row with an empty `server_id` covers the project as a whole.
|
|
478
502
|
*/
|
|
479
503
|
get: operations["get-sli-report"];
|
|
480
504
|
put?: never;
|
|
@@ -493,21 +517,21 @@ export interface paths {
|
|
|
493
517
|
cookie?: never;
|
|
494
518
|
};
|
|
495
519
|
/**
|
|
496
|
-
*
|
|
497
|
-
* @description
|
|
520
|
+
* Get the availability target of this project
|
|
521
|
+
* @description A project that has never set one returns 404 rather than a default target: making no promise and promising 99.9% are different things.
|
|
498
522
|
*/
|
|
499
523
|
get: operations["get-slo"];
|
|
500
524
|
/**
|
|
501
|
-
*
|
|
502
|
-
* @description
|
|
525
|
+
* Set the availability target of this project, or change it
|
|
526
|
+
* @description One SLO per project, **create or replace**.
|
|
503
527
|
*
|
|
504
|
-
* `min_severity`
|
|
528
|
+
* `min_severity` must be chosen explicitly: it defines what counts as unavailable, which is half of what the target means.
|
|
505
529
|
*/
|
|
506
530
|
put: operations["put-slo"];
|
|
507
531
|
post?: never;
|
|
508
532
|
/**
|
|
509
|
-
*
|
|
510
|
-
* @description
|
|
533
|
+
* Remove the availability target of this project
|
|
534
|
+
* @description Availability is no longer tracked from this point on.
|
|
511
535
|
*/
|
|
512
536
|
delete: operations["delete-slo"];
|
|
513
537
|
options?: never;
|
|
@@ -515,187 +539,608 @@ export interface paths {
|
|
|
515
539
|
patch?: never;
|
|
516
540
|
trace?: never;
|
|
517
541
|
};
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
message: string;
|
|
525
|
-
meta?: {
|
|
526
|
-
[key: string]: unknown;
|
|
527
|
-
};
|
|
528
|
-
/** Format: int64 */
|
|
529
|
-
status: number;
|
|
542
|
+
"/api/v1/status-page": {
|
|
543
|
+
parameters: {
|
|
544
|
+
query?: never;
|
|
545
|
+
header?: never;
|
|
546
|
+
path?: never;
|
|
547
|
+
cookie?: never;
|
|
530
548
|
};
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
549
|
+
/**
|
|
550
|
+
* Get the status page of this project
|
|
551
|
+
* @description A project has at most one status page. A project that has never created one returns 404.
|
|
552
|
+
*/
|
|
553
|
+
get: operations["get-status-page"];
|
|
554
|
+
/**
|
|
555
|
+
* Create the status page, or replace its configuration
|
|
556
|
+
* @description **Create or replace**: changing the title, switching the domain, publishing and unpublishing are all done by sending the complete configuration again.
|
|
557
|
+
*
|
|
558
|
+
* While `published` is false the public address returns 404, including any custom domain already bound. A newly created page is unpublished by default, so that a page still being configured has no address that opens.
|
|
559
|
+
*
|
|
560
|
+
* `slug` and `custom_domain` are **globally unique**; a value already taken returns 409.
|
|
561
|
+
*/
|
|
562
|
+
put: operations["put-status-page"];
|
|
563
|
+
post?: never;
|
|
564
|
+
/**
|
|
565
|
+
* Delete the status page
|
|
566
|
+
* @description Its groups, components, availability history, incident notices and scheduled maintenance are removed together, and cannot be recovered. The slug and custom domain are released.
|
|
567
|
+
*/
|
|
568
|
+
delete: operations["delete-status-page"];
|
|
569
|
+
options?: never;
|
|
570
|
+
head?: never;
|
|
571
|
+
patch?: never;
|
|
572
|
+
trace?: never;
|
|
573
|
+
};
|
|
574
|
+
"/api/v1/status-page/order": {
|
|
575
|
+
parameters: {
|
|
576
|
+
query?: never;
|
|
577
|
+
header?: never;
|
|
578
|
+
path?: never;
|
|
579
|
+
cookie?: never;
|
|
536
580
|
};
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
581
|
+
get?: never;
|
|
582
|
+
/**
|
|
583
|
+
* Set the order of the top level of the page
|
|
584
|
+
* @description Submits the **entire** top-level order in one call rather than moving a single entry to a given position.
|
|
585
|
+
*
|
|
586
|
+
* The top level interleaves groups and ungrouped components, so the order is expressed as one list covering both.
|
|
587
|
+
*
|
|
588
|
+
* Each entry carries either `group_id` or `component_id`. Entries not listed are placed after those that are.
|
|
589
|
+
*/
|
|
590
|
+
put: operations["put-status-page-order"];
|
|
591
|
+
post?: never;
|
|
592
|
+
delete?: never;
|
|
593
|
+
options?: never;
|
|
594
|
+
head?: never;
|
|
595
|
+
patch?: never;
|
|
596
|
+
trace?: never;
|
|
597
|
+
};
|
|
598
|
+
"/api/v1/status-page/groups": {
|
|
599
|
+
parameters: {
|
|
600
|
+
query?: never;
|
|
601
|
+
header?: never;
|
|
602
|
+
path?: never;
|
|
603
|
+
cookie?: never;
|
|
554
604
|
};
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
605
|
+
/** List groups */
|
|
606
|
+
get: operations["list-status-page-groups"];
|
|
607
|
+
put?: never;
|
|
608
|
+
/**
|
|
609
|
+
* Create a group
|
|
610
|
+
* @description A group is one level of collapsing applied to components on the page. There is exactly one level; groups cannot be nested.
|
|
611
|
+
*/
|
|
612
|
+
post: operations["create-status-page-group"];
|
|
613
|
+
delete?: never;
|
|
614
|
+
options?: never;
|
|
615
|
+
head?: never;
|
|
616
|
+
patch?: never;
|
|
617
|
+
trace?: never;
|
|
618
|
+
};
|
|
619
|
+
"/api/v1/status-page/groups/{groupId}": {
|
|
620
|
+
parameters: {
|
|
621
|
+
query?: never;
|
|
622
|
+
header?: never;
|
|
623
|
+
path: {
|
|
624
|
+
groupId: string;
|
|
625
|
+
};
|
|
626
|
+
cookie?: never;
|
|
558
627
|
};
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
host_connection: string;
|
|
580
|
-
host_display_name: string;
|
|
581
|
-
/** Format: uuid */
|
|
582
|
-
id: string;
|
|
583
|
-
/**
|
|
584
|
-
* @description 监控系统是否判定已恢复。它与是否有人了结这条告警是两件事
|
|
585
|
-
* @enum {string}
|
|
586
|
-
*/
|
|
587
|
-
incident_status: "PROBLEM" | "RESOLVED";
|
|
588
|
-
items: components["schemas"]["MonitoringItemResource"][] | null;
|
|
589
|
-
name: string;
|
|
590
|
-
/** @description 触发器配的那行现场数据 */
|
|
591
|
-
operational_data: string;
|
|
592
|
-
/** Format: uuid */
|
|
593
|
-
project_id: string;
|
|
594
|
-
/** Format: date-time */
|
|
595
|
-
resolved_at: string | null;
|
|
596
|
-
resolved_trigger_expression: string;
|
|
597
|
-
/** Format: uuid */
|
|
598
|
-
server_id: string;
|
|
599
|
-
server_name: string;
|
|
600
|
-
/** @enum {string} */
|
|
601
|
-
severity: "NOT_CLASSIFIED" | "INFORMATION" | "WARNING" | "AVERAGE" | "HIGH" | "DISASTER";
|
|
602
|
-
/** Format: date-time */
|
|
603
|
-
started_at: string;
|
|
604
|
-
tags: components["schemas"]["TagResource"][] | null;
|
|
605
|
-
trigger_expression: string;
|
|
606
|
-
zabbix_event_id: string;
|
|
628
|
+
get?: never;
|
|
629
|
+
/** Update a group */
|
|
630
|
+
put: operations["update-status-page-group"];
|
|
631
|
+
post?: never;
|
|
632
|
+
/**
|
|
633
|
+
* Delete a group
|
|
634
|
+
* @description The components in it are **not deleted**. They return to the top level as ungrouped components, keeping their availability history and the incident notices that reference them.
|
|
635
|
+
*/
|
|
636
|
+
delete: operations["delete-status-page-group"];
|
|
637
|
+
options?: never;
|
|
638
|
+
head?: never;
|
|
639
|
+
patch?: never;
|
|
640
|
+
trace?: never;
|
|
641
|
+
};
|
|
642
|
+
"/api/v1/status-page/groups/{groupId}/order": {
|
|
643
|
+
parameters: {
|
|
644
|
+
query?: never;
|
|
645
|
+
header?: never;
|
|
646
|
+
path?: never;
|
|
647
|
+
cookie?: never;
|
|
607
648
|
};
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
*/
|
|
625
|
-
total: number;
|
|
649
|
+
get?: never;
|
|
650
|
+
/** Set the order of components within a group */
|
|
651
|
+
put: operations["put-status-page-group-order"];
|
|
652
|
+
post?: never;
|
|
653
|
+
delete?: never;
|
|
654
|
+
options?: never;
|
|
655
|
+
head?: never;
|
|
656
|
+
patch?: never;
|
|
657
|
+
trace?: never;
|
|
658
|
+
};
|
|
659
|
+
"/api/v1/status-page/components": {
|
|
660
|
+
parameters: {
|
|
661
|
+
query?: never;
|
|
662
|
+
header?: never;
|
|
663
|
+
path?: never;
|
|
664
|
+
cookie?: never;
|
|
626
665
|
};
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
666
|
+
/**
|
|
667
|
+
* List components
|
|
668
|
+
* @description A component is one row on the status page: an externally promised capability. It is not a machine — a single component may be backed by several machines and several web checks.
|
|
669
|
+
*/
|
|
670
|
+
get: operations["list-status-page-components"];
|
|
671
|
+
put?: never;
|
|
672
|
+
/**
|
|
673
|
+
* Create a component
|
|
674
|
+
* @description `name` is **customer-facing copy** and appears verbatim on the public page; do not use machine names.
|
|
675
|
+
*
|
|
676
|
+
* `auto_status_min_severity` sets how severe an alert must be before it changes the status of this row; anything below it has no effect. The default is AVERAGE. Lower settings tend to keep the page permanently off-green, at which point people stop reading it.
|
|
677
|
+
*/
|
|
678
|
+
post: operations["create-status-page-component"];
|
|
679
|
+
delete?: never;
|
|
680
|
+
options?: never;
|
|
681
|
+
head?: never;
|
|
682
|
+
patch?: never;
|
|
683
|
+
trace?: never;
|
|
684
|
+
};
|
|
685
|
+
"/api/v1/status-page/components/{componentId}": {
|
|
686
|
+
parameters: {
|
|
687
|
+
query?: never;
|
|
688
|
+
header?: never;
|
|
689
|
+
path: {
|
|
690
|
+
componentId: string;
|
|
691
|
+
};
|
|
692
|
+
cookie?: never;
|
|
630
693
|
};
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
694
|
+
/** Get a component */
|
|
695
|
+
get: operations["get-status-page-component"];
|
|
696
|
+
/**
|
|
697
|
+
* Update a component
|
|
698
|
+
* @description `started_on` cannot be changed: it determines where the availability bar stops showing as unmeasured, and changing it would rewrite history that has already been published.
|
|
699
|
+
*/
|
|
700
|
+
put: operations["update-status-page-component"];
|
|
701
|
+
post?: never;
|
|
702
|
+
/**
|
|
703
|
+
* Delete a component
|
|
704
|
+
* @description Its availability history is removed along with it. Passages in already-published notices that refer to it are retained, since customers may already have read them.
|
|
705
|
+
*/
|
|
706
|
+
delete: operations["delete-status-page-component"];
|
|
707
|
+
options?: never;
|
|
708
|
+
head?: never;
|
|
709
|
+
patch?: never;
|
|
710
|
+
trace?: never;
|
|
711
|
+
};
|
|
712
|
+
"/api/v1/status-page/components/{componentId}/sources": {
|
|
713
|
+
parameters: {
|
|
714
|
+
query?: never;
|
|
715
|
+
header?: never;
|
|
716
|
+
path: {
|
|
717
|
+
componentId: string;
|
|
718
|
+
};
|
|
719
|
+
cookie?: never;
|
|
635
720
|
};
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
721
|
+
/**
|
|
722
|
+
* List the monitored sources bound to a component
|
|
723
|
+
* @description Monitored sources are internal information and **never appear on the public page**.
|
|
724
|
+
*/
|
|
725
|
+
get: operations["list-status-page-component-sources"];
|
|
726
|
+
/**
|
|
727
|
+
* Set the complete list of monitored sources for a component
|
|
728
|
+
* @description Submits the **complete** set of sources; anything not listed is unbound.
|
|
729
|
+
*
|
|
730
|
+
* Once bound, alerts on these machines and web checks drive the status of the component automatically: DISASTER and HIGH are reported as a major outage, AVERAGE as a partial outage, and WARNING as degraded performance. Alerts below `auto_status_min_severity` have no effect.
|
|
731
|
+
*
|
|
732
|
+
* `show_url` controls whether the checked address is shown on the public page. It is off by default.
|
|
733
|
+
*/
|
|
734
|
+
put: operations["put-status-page-component-sources"];
|
|
735
|
+
post?: never;
|
|
736
|
+
delete?: never;
|
|
737
|
+
options?: never;
|
|
738
|
+
head?: never;
|
|
739
|
+
patch?: never;
|
|
740
|
+
trace?: never;
|
|
741
|
+
};
|
|
742
|
+
"/api/v1/status-page/incidents": {
|
|
743
|
+
parameters: {
|
|
744
|
+
query?: never;
|
|
745
|
+
header?: never;
|
|
746
|
+
path?: never;
|
|
747
|
+
cookie?: never;
|
|
641
748
|
};
|
|
642
|
-
|
|
643
|
-
|
|
749
|
+
/**
|
|
750
|
+
* List the incident notices on the status page
|
|
751
|
+
* @description These are **customer-facing notices**, distinct from the monitoring incidents under `/incidents`. Nothing from the latter is carried over; the text here is written by your team.
|
|
752
|
+
*/
|
|
753
|
+
get: operations["list-status-page-incidents"];
|
|
754
|
+
put?: never;
|
|
755
|
+
/**
|
|
756
|
+
* Publish an incident notice
|
|
757
|
+
* @description Publishing a notice and writing its first update are a single operation: a notice with no updates would appear as a bare title on a page that has already been delivered to readers.
|
|
758
|
+
*
|
|
759
|
+
* `started_at` is when the **incident began**, not when the notice was published. The two are usually minutes to hours apart, and using the publication time would understate the impact window that customers can compare against their own logs. Backfilling a past incident relies on the same field.
|
|
760
|
+
*
|
|
761
|
+
* The statuses given in `components` take effect on the public page immediately and count towards availability.
|
|
762
|
+
*/
|
|
763
|
+
post: operations["publish-status-page-incident"];
|
|
764
|
+
delete?: never;
|
|
765
|
+
options?: never;
|
|
766
|
+
head?: never;
|
|
767
|
+
patch?: never;
|
|
768
|
+
trace?: never;
|
|
769
|
+
};
|
|
770
|
+
"/api/v1/status-page/incidents/{incidentId}": {
|
|
771
|
+
parameters: {
|
|
772
|
+
query?: never;
|
|
773
|
+
header?: never;
|
|
774
|
+
path?: never;
|
|
775
|
+
cookie?: never;
|
|
644
776
|
};
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
777
|
+
/** Get an incident notice */
|
|
778
|
+
get: operations["get-status-page-incident"];
|
|
779
|
+
put?: never;
|
|
780
|
+
post?: never;
|
|
781
|
+
delete?: never;
|
|
782
|
+
options?: never;
|
|
783
|
+
head?: never;
|
|
784
|
+
patch?: never;
|
|
785
|
+
trace?: never;
|
|
786
|
+
};
|
|
787
|
+
"/api/v1/status-page/incidents/{incidentId}/updates": {
|
|
788
|
+
parameters: {
|
|
789
|
+
query?: never;
|
|
790
|
+
header?: never;
|
|
791
|
+
path?: never;
|
|
792
|
+
cookie?: never;
|
|
793
|
+
};
|
|
794
|
+
get?: never;
|
|
795
|
+
put?: never;
|
|
796
|
+
/**
|
|
797
|
+
* Append an update to an incident notice
|
|
798
|
+
* @description Published updates are never modified; a correction is issued as a new update. Customers may already have forwarded the original, and a silent rewrite would leave the two sides with different histories.
|
|
799
|
+
*
|
|
800
|
+
* `components` lists only the components **being changed** by this update; those not listed keep their current status. Setting `status` to `RESOLVED` returns every component this notice has affected to operational and closes the notice. A closed notice accepts no further updates.
|
|
801
|
+
*/
|
|
802
|
+
post: operations["post-status-page-incident-update"];
|
|
803
|
+
delete?: never;
|
|
804
|
+
options?: never;
|
|
805
|
+
head?: never;
|
|
806
|
+
patch?: never;
|
|
807
|
+
trace?: never;
|
|
808
|
+
};
|
|
809
|
+
"/api/v1/status-page/maintenances": {
|
|
810
|
+
parameters: {
|
|
811
|
+
query?: never;
|
|
812
|
+
header?: never;
|
|
813
|
+
path?: never;
|
|
814
|
+
cookie?: never;
|
|
815
|
+
};
|
|
816
|
+
/** List scheduled maintenance */
|
|
817
|
+
get: operations["list-status-page-maintenances"];
|
|
818
|
+
put?: never;
|
|
819
|
+
/**
|
|
820
|
+
* Schedule maintenance
|
|
821
|
+
* @description Maintenance starts and finishes automatically at the scheduled times; nobody needs to be present. While it runs, the affected components are shown as under maintenance and **availability is not reduced** — planned work should not consume the availability you promise to customers, which is the point of announcing it in advance.
|
|
822
|
+
*
|
|
823
|
+
* This is separate from `/maintenance-windows`, which suppresses alerting for a period. This endpoint announces the work to your customers. The two are usually created together: without suppression, restarts during the maintenance raise alerts and mark the components unavailable.
|
|
824
|
+
*/
|
|
825
|
+
post: operations["schedule-status-page-maintenance"];
|
|
826
|
+
delete?: never;
|
|
827
|
+
options?: never;
|
|
828
|
+
head?: never;
|
|
829
|
+
patch?: never;
|
|
830
|
+
trace?: never;
|
|
831
|
+
};
|
|
832
|
+
"/api/v1/status-page/maintenances/{maintenanceId}": {
|
|
833
|
+
parameters: {
|
|
834
|
+
query?: never;
|
|
835
|
+
header?: never;
|
|
836
|
+
path?: never;
|
|
837
|
+
cookie?: never;
|
|
838
|
+
};
|
|
839
|
+
/** Get a scheduled maintenance */
|
|
840
|
+
get: operations["get-status-page-maintenance"];
|
|
841
|
+
put?: never;
|
|
842
|
+
post?: never;
|
|
843
|
+
delete?: never;
|
|
844
|
+
options?: never;
|
|
845
|
+
head?: never;
|
|
846
|
+
patch?: never;
|
|
847
|
+
trace?: never;
|
|
848
|
+
};
|
|
849
|
+
"/api/v1/status-page/maintenances/{maintenanceId}/cancel": {
|
|
850
|
+
parameters: {
|
|
851
|
+
query?: never;
|
|
852
|
+
header?: never;
|
|
853
|
+
path?: never;
|
|
854
|
+
cookie?: never;
|
|
855
|
+
};
|
|
856
|
+
get?: never;
|
|
857
|
+
put?: never;
|
|
858
|
+
/**
|
|
859
|
+
* Cancel a maintenance that has not started
|
|
860
|
+
* @description Cancelled rather than deleted, so that readers who saw the announcement have an explanation. Maintenance that has already started cannot be cancelled; finish it early instead.
|
|
861
|
+
*/
|
|
862
|
+
post: operations["cancel-status-page-maintenance"];
|
|
863
|
+
delete?: never;
|
|
864
|
+
options?: never;
|
|
865
|
+
head?: never;
|
|
866
|
+
patch?: never;
|
|
867
|
+
trace?: never;
|
|
868
|
+
};
|
|
869
|
+
"/api/v1/status-page/maintenances/{maintenanceId}/complete": {
|
|
870
|
+
parameters: {
|
|
871
|
+
query?: never;
|
|
872
|
+
header?: never;
|
|
873
|
+
path?: never;
|
|
874
|
+
cookie?: never;
|
|
875
|
+
};
|
|
876
|
+
get?: never;
|
|
877
|
+
put?: never;
|
|
878
|
+
/**
|
|
879
|
+
* Finish a running maintenance early
|
|
880
|
+
* @description Optional: maintenance finishes on its own at the scheduled end time. Use this endpoint when the work is done ahead of schedule; the affected components return to operational immediately.
|
|
881
|
+
*/
|
|
882
|
+
post: operations["complete-status-page-maintenance"];
|
|
883
|
+
delete?: never;
|
|
884
|
+
options?: never;
|
|
885
|
+
head?: never;
|
|
886
|
+
patch?: never;
|
|
887
|
+
trace?: never;
|
|
888
|
+
};
|
|
889
|
+
"/api/v1/web-checks/{checkId}": {
|
|
890
|
+
parameters: {
|
|
891
|
+
query?: never;
|
|
892
|
+
header?: never;
|
|
893
|
+
path: {
|
|
894
|
+
checkId: string;
|
|
895
|
+
};
|
|
896
|
+
cookie?: never;
|
|
897
|
+
};
|
|
898
|
+
/** Get a project-level web check */
|
|
899
|
+
get: operations["get-project-web-check"];
|
|
900
|
+
/**
|
|
901
|
+
* Create a web check that is not tied to a machine, or replace it by the same id
|
|
902
|
+
* @description **Create or replace**: to modify a check, call this endpoint again with the same id.
|
|
903
|
+
*
|
|
904
|
+
* Unlike `/servers/{serverId}/web-checks/{checkId}`, this check does not belong to any machine — use it when the target is simply a URL. Nothing needs to be enrolled first.
|
|
905
|
+
*
|
|
906
|
+
* A check bound to a machine is removed together with that machine; a project-level check is not. Where a check belongs cannot be changed afterwards: move it by deleting and recreating it.
|
|
907
|
+
*/
|
|
908
|
+
put: operations["put-project-web-check"];
|
|
909
|
+
post?: never;
|
|
910
|
+
/**
|
|
911
|
+
* Delete a project-level web check
|
|
912
|
+
* @description The corresponding check task and trigger are removed from the monitoring system as well.
|
|
913
|
+
*/
|
|
914
|
+
delete: operations["delete-project-web-check"];
|
|
915
|
+
options?: never;
|
|
916
|
+
head?: never;
|
|
917
|
+
patch?: never;
|
|
918
|
+
trace?: never;
|
|
919
|
+
};
|
|
920
|
+
"/api/v1/status-page/domain": {
|
|
921
|
+
parameters: {
|
|
922
|
+
query?: never;
|
|
923
|
+
header?: never;
|
|
924
|
+
path?: never;
|
|
925
|
+
cookie?: never;
|
|
926
|
+
};
|
|
927
|
+
/**
|
|
928
|
+
* Get the custom domain and its certificate state
|
|
929
|
+
* @description Reports whether the domain currently resolves to the status page and where its certificate stands.
|
|
930
|
+
*
|
|
931
|
+
* `expected_cname` is the value the domain must point at. `observed_cname` is what it currently resolves to, which is what to show the user when verification fails — "verification failed" on its own tells them nothing about what to fix.
|
|
932
|
+
*/
|
|
933
|
+
get: operations["get-status-page-domain"];
|
|
934
|
+
/**
|
|
935
|
+
* Bind a custom domain to this status page
|
|
936
|
+
* @description The domain must already point at the status page by CNAME. Binding is rejected until it does, and the error carries both the expected and the observed target.
|
|
937
|
+
*
|
|
938
|
+
* Ownership is verified before the domain is stored, and it is verified again before each certificate is issued: a domain whose CNAME is later removed stops being served.
|
|
939
|
+
*
|
|
940
|
+
* A certificate is requested in the background — this call does not wait for it. Poll GET on this endpoint to follow its progress; until a certificate is active, the domain does not serve HTTPS while the page remains reachable at its shared address.
|
|
941
|
+
*/
|
|
942
|
+
put: operations["put-status-page-domain"];
|
|
943
|
+
post?: never;
|
|
944
|
+
/**
|
|
945
|
+
* Unbind the custom domain
|
|
946
|
+
* @description The page stays reachable at its shared address. Certificate renewal for the domain stops; the certificate already issued is left to expire.
|
|
947
|
+
*/
|
|
948
|
+
delete: operations["delete-status-page-domain"];
|
|
949
|
+
options?: never;
|
|
950
|
+
head?: never;
|
|
951
|
+
patch?: never;
|
|
952
|
+
trace?: never;
|
|
953
|
+
};
|
|
954
|
+
}
|
|
955
|
+
export type webhooks = Record<string, never>;
|
|
956
|
+
export interface components {
|
|
957
|
+
schemas: {
|
|
958
|
+
Error: {
|
|
959
|
+
code?: string;
|
|
656
960
|
message: string;
|
|
961
|
+
meta?: {
|
|
962
|
+
[key: string]: unknown;
|
|
963
|
+
};
|
|
964
|
+
/** Format: int64 */
|
|
965
|
+
status: number;
|
|
966
|
+
};
|
|
967
|
+
IncidentFollowerResource: {
|
|
968
|
+
display_name: string;
|
|
657
969
|
/** Format: date-time */
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
source: "SYSTEM" | "OPERATOR" | "ZABBIX";
|
|
661
|
-
subject_display_name: string;
|
|
662
|
-
/** @description 被指派 / 被取消关注的那个人 */
|
|
663
|
-
subject_user_id: string;
|
|
970
|
+
followed_at: string;
|
|
971
|
+
user_id: string;
|
|
664
972
|
};
|
|
665
|
-
|
|
666
|
-
|
|
973
|
+
MonitoringItemResource: {
|
|
974
|
+
/** @description Such as last, avg, min or max */
|
|
975
|
+
aggregation_function: string;
|
|
976
|
+
/** Format: int64 */
|
|
977
|
+
evaluation_window_seconds: number;
|
|
978
|
+
item_id: string;
|
|
979
|
+
key: string;
|
|
980
|
+
name: string;
|
|
981
|
+
operator: string;
|
|
982
|
+
/**
|
|
983
|
+
* Format: double
|
|
984
|
+
* @description Present only when `threshold_status` is RESOLVED
|
|
985
|
+
*/
|
|
986
|
+
threshold: number | null;
|
|
987
|
+
threshold_status: string;
|
|
988
|
+
/** @description The value at the moment of the trigger, stored as collected */
|
|
989
|
+
value: string;
|
|
667
990
|
};
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
/** @description 下一页的游标;为空表示已经到底 */
|
|
672
|
-
next_cursor: string;
|
|
991
|
+
TagResource: {
|
|
992
|
+
tag: string;
|
|
993
|
+
value: string;
|
|
673
994
|
};
|
|
674
|
-
|
|
995
|
+
IncidentResource: {
|
|
996
|
+
acknowledge_message: string;
|
|
997
|
+
acknowledged: boolean;
|
|
998
|
+
/** Format: date-time */
|
|
999
|
+
acknowledged_at: string | null;
|
|
1000
|
+
acknowledged_by_display_name: string;
|
|
1001
|
+
acknowledged_by_user_id: string;
|
|
1002
|
+
/** Format: date-time */
|
|
1003
|
+
assigned_at: string | null;
|
|
1004
|
+
assignee_display_name: string;
|
|
1005
|
+
assignee_user_id: string;
|
|
1006
|
+
close_message: string;
|
|
1007
|
+
close_reason: string;
|
|
1008
|
+
/** Format: date-time */
|
|
1009
|
+
closed_at: string | null;
|
|
1010
|
+
closed_by_display_name: string;
|
|
1011
|
+
closed_by_user_id: string;
|
|
675
1012
|
/** Format: int64 */
|
|
676
1013
|
duration_seconds: number;
|
|
1014
|
+
followers: components["schemas"]["IncidentFollowerResource"][] | null;
|
|
1015
|
+
host_connection: string;
|
|
1016
|
+
host_display_name: string;
|
|
1017
|
+
/** Format: uuid */
|
|
1018
|
+
id: string;
|
|
677
1019
|
/**
|
|
678
|
-
*
|
|
679
|
-
* @
|
|
1020
|
+
* @description Whether monitoring considers the problem recovered. Independent of whether anyone has closed the incident
|
|
1021
|
+
* @enum {string}
|
|
680
1022
|
*/
|
|
681
|
-
|
|
1023
|
+
incident_status: "PROBLEM" | "RESOLVED";
|
|
1024
|
+
items: components["schemas"]["MonitoringItemResource"][] | null;
|
|
1025
|
+
name: string;
|
|
1026
|
+
/** @description The operational data line configured on the trigger */
|
|
1027
|
+
operational_data: string;
|
|
1028
|
+
/** Format: uuid */
|
|
1029
|
+
project_id: string;
|
|
1030
|
+
/** Format: date-time */
|
|
1031
|
+
resolved_at: string | null;
|
|
1032
|
+
resolved_trigger_expression: string;
|
|
1033
|
+
/**
|
|
1034
|
+
* Format: uuid
|
|
1035
|
+
* @description The machine this alert is about. Null when the alert is not about a machine
|
|
1036
|
+
*/
|
|
1037
|
+
server_id: string | null;
|
|
1038
|
+
/** @description Empty when server_id is null */
|
|
1039
|
+
server_name: string;
|
|
682
1040
|
/** @enum {string} */
|
|
683
|
-
|
|
1041
|
+
severity: "NOT_CLASSIFIED" | "INFORMATION" | "WARNING" | "AVERAGE" | "HIGH" | "DISASTER";
|
|
1042
|
+
/** Format: date-time */
|
|
1043
|
+
started_at: string;
|
|
1044
|
+
tags: components["schemas"]["TagResource"][] | null;
|
|
1045
|
+
trigger_expression: string;
|
|
684
1046
|
/**
|
|
685
|
-
* Format:
|
|
686
|
-
* @description
|
|
1047
|
+
* Format: uuid
|
|
1048
|
+
* @description The web check that reported this alert. Null when the alert did not come from a web check. Both this and server_id are set when the check runs on one of your machines
|
|
687
1049
|
*/
|
|
688
|
-
|
|
1050
|
+
web_check_id: string | null;
|
|
1051
|
+
zabbix_event_id: string;
|
|
1052
|
+
};
|
|
1053
|
+
LengthAwarePageIncidentResource: {
|
|
1054
|
+
/** @description The records in this page */
|
|
1055
|
+
items: components["schemas"]["IncidentResource"][];
|
|
689
1056
|
/**
|
|
690
|
-
* Format:
|
|
691
|
-
* @description
|
|
1057
|
+
* Format: int64
|
|
1058
|
+
* @description Maximum records per page, echoing the request
|
|
692
1059
|
*/
|
|
693
|
-
|
|
1060
|
+
limit: number;
|
|
694
1061
|
/**
|
|
695
1062
|
* Format: int64
|
|
696
|
-
* @description
|
|
1063
|
+
* @description Number of records skipped, echoing the request
|
|
697
1064
|
*/
|
|
698
|
-
|
|
1065
|
+
offset: number;
|
|
1066
|
+
/**
|
|
1067
|
+
* Format: int64
|
|
1068
|
+
* @description Total number of matches, not just this page
|
|
1069
|
+
*/
|
|
1070
|
+
total: number;
|
|
1071
|
+
};
|
|
1072
|
+
AcknowledgeIncidentRequestBody: {
|
|
1073
|
+
/** @description Also written to the acknowledgement record in the monitoring system */
|
|
1074
|
+
message?: string;
|
|
1075
|
+
};
|
|
1076
|
+
AssignIncidentRequestBody: {
|
|
1077
|
+
/** @description Defaults to the user id. The timeline keeps a copy of the name as it was at the time */
|
|
1078
|
+
assignee_display_name?: string;
|
|
1079
|
+
assignee_user_id?: string;
|
|
1080
|
+
};
|
|
1081
|
+
CloseIncidentRequestBody: {
|
|
1082
|
+
/** @description Required when `reason` is OTHER; the request is rejected otherwise */
|
|
1083
|
+
message?: string;
|
|
1084
|
+
/** @enum {string} */
|
|
1085
|
+
reason: "RECOVERED" | "FIXED" | "FALSE_POSITIVE" | "DUPLICATE" | "NO_ACTION_REQUIRED" | "ACCEPTED_RISK" | "OTHER";
|
|
1086
|
+
};
|
|
1087
|
+
AddCommentRequestBody: {
|
|
1088
|
+
message: string;
|
|
1089
|
+
};
|
|
1090
|
+
IncidentActivityResource: {
|
|
1091
|
+
/** @enum {string} */
|
|
1092
|
+
activity_type: "OPENED" | "RECOVERED" | "ACKNOWLEDGED" | "ASSIGNED" | "UNASSIGNED" | "FOLLOWER_ADDED" | "FOLLOWER_REMOVED" | "COMMENT" | "CLOSED" | "REOPENED";
|
|
1093
|
+
actor_display_name: string;
|
|
1094
|
+
/** @description The operator. Empty when the source is SYSTEM or ZABBIX */
|
|
1095
|
+
actor_user_id: string;
|
|
1096
|
+
close_reason: string;
|
|
1097
|
+
/** Format: uuid */
|
|
1098
|
+
id: string;
|
|
1099
|
+
/** Format: uuid */
|
|
1100
|
+
incident_id: string;
|
|
1101
|
+
message: string;
|
|
1102
|
+
/** Format: date-time */
|
|
1103
|
+
occurred_at: string;
|
|
1104
|
+
/** @enum {string} */
|
|
1105
|
+
source: "SYSTEM" | "OPERATOR" | "ZABBIX";
|
|
1106
|
+
subject_display_name: string;
|
|
1107
|
+
/** @description The user who was assigned, or removed from the followers */
|
|
1108
|
+
subject_user_id: string;
|
|
1109
|
+
};
|
|
1110
|
+
SetFollowingRequestBody: {
|
|
1111
|
+
following: boolean;
|
|
1112
|
+
};
|
|
1113
|
+
CursorPageIncidentActivityResource: {
|
|
1114
|
+
/** @description The records in this page */
|
|
1115
|
+
items: components["schemas"]["IncidentActivityResource"][];
|
|
1116
|
+
/** @description Cursor for the next page. Empty means the end has been reached */
|
|
1117
|
+
next_cursor: string;
|
|
1118
|
+
};
|
|
1119
|
+
MaintenancePeriodResource: {
|
|
1120
|
+
/** Format: int64 */
|
|
1121
|
+
duration_seconds: number;
|
|
1122
|
+
/**
|
|
1123
|
+
* Format: int64
|
|
1124
|
+
* @description DAILY and WEEKLY: every N days or every N weeks
|
|
1125
|
+
*/
|
|
1126
|
+
every: number;
|
|
1127
|
+
/** @enum {string} */
|
|
1128
|
+
kind: "ONCE" | "DAILY" | "WEEKLY";
|
|
1129
|
+
/**
|
|
1130
|
+
* Format: int64
|
|
1131
|
+
* @description DAILY and WEEKLY: seconds from midnight, in the timezone of the window
|
|
1132
|
+
*/
|
|
1133
|
+
start_time_seconds: number;
|
|
1134
|
+
/**
|
|
1135
|
+
* Format: date-time
|
|
1136
|
+
* @description Present only for ONCE
|
|
1137
|
+
*/
|
|
1138
|
+
starts_at: string | null;
|
|
1139
|
+
/**
|
|
1140
|
+
* Format: int64
|
|
1141
|
+
* @description WEEKLY: bitmap of weekdays, **Monday is the lowest bit**
|
|
1142
|
+
*/
|
|
1143
|
+
weekdays: number;
|
|
699
1144
|
};
|
|
700
1145
|
MaintenanceWindowResource: {
|
|
701
1146
|
/** Format: date-time */
|
|
@@ -708,7 +1153,7 @@ export interface components {
|
|
|
708
1153
|
period: components["schemas"]["MaintenancePeriodResource"];
|
|
709
1154
|
/** Format: uuid */
|
|
710
1155
|
project_id: string;
|
|
711
|
-
/** @description
|
|
1156
|
+
/** @description Empty covers the **entire project** */
|
|
712
1157
|
server_ids: string[] | null;
|
|
713
1158
|
/** @enum {string} */
|
|
714
1159
|
sync_status: "PENDING" | "ACTIVE" | "FAILED" | "EXPIRED";
|
|
@@ -724,31 +1169,31 @@ export interface components {
|
|
|
724
1169
|
duration_seconds?: number;
|
|
725
1170
|
/**
|
|
726
1171
|
* Format: int64
|
|
727
|
-
* @description DAILY
|
|
1172
|
+
* @description DAILY and WEEKLY: every N days or every N weeks
|
|
728
1173
|
*/
|
|
729
1174
|
every?: number;
|
|
730
1175
|
/** @enum {string} */
|
|
731
1176
|
kind: "ONCE" | "DAILY" | "WEEKLY";
|
|
732
1177
|
/**
|
|
733
1178
|
* Format: int64
|
|
734
|
-
* @description DAILY
|
|
1179
|
+
* @description DAILY and WEEKLY: seconds from midnight, in the timezone of the window
|
|
735
1180
|
*/
|
|
736
1181
|
start_time_seconds?: number;
|
|
737
1182
|
/**
|
|
738
1183
|
* Format: date-time
|
|
739
|
-
* @description
|
|
1184
|
+
* @description Used only by ONCE
|
|
740
1185
|
*/
|
|
741
1186
|
starts_at?: string;
|
|
742
1187
|
/**
|
|
743
1188
|
* Format: int64
|
|
744
|
-
* @description WEEKLY
|
|
1189
|
+
* @description WEEKLY: bitmap of weekdays, **Monday is the lowest bit**
|
|
745
1190
|
*/
|
|
746
1191
|
weekdays?: number;
|
|
747
1192
|
};
|
|
748
1193
|
PutMaintenanceWindowRequestBody: {
|
|
749
1194
|
/**
|
|
750
1195
|
* Format: date-time
|
|
751
|
-
* @description
|
|
1196
|
+
* @description Start of the period in which the rule is effective
|
|
752
1197
|
*/
|
|
753
1198
|
active_since: string;
|
|
754
1199
|
/** Format: date-time */
|
|
@@ -757,7 +1202,7 @@ export interface components {
|
|
|
757
1202
|
name: string;
|
|
758
1203
|
period: components["schemas"]["MaintenancePeriodRequest"];
|
|
759
1204
|
server_ids?: string[] | null;
|
|
760
|
-
/** @description IANA
|
|
1205
|
+
/** @description IANA name such as Asia/Shanghai. Empty uses the configured default */
|
|
761
1206
|
timezone?: string;
|
|
762
1207
|
};
|
|
763
1208
|
CountResource: {
|
|
@@ -814,7 +1259,7 @@ export interface components {
|
|
|
814
1259
|
severity: string;
|
|
815
1260
|
/** Format: double */
|
|
816
1261
|
threshold: number;
|
|
817
|
-
/** @description
|
|
1262
|
+
/** @description Labels the line in the chart legend */
|
|
818
1263
|
trigger_name: string;
|
|
819
1264
|
};
|
|
820
1265
|
MetricResponseBody: {
|
|
@@ -823,7 +1268,7 @@ export interface components {
|
|
|
823
1268
|
effective_from: string;
|
|
824
1269
|
/** Format: date-time */
|
|
825
1270
|
effective_to: string;
|
|
826
|
-
/** @description
|
|
1271
|
+
/** @description Data comes from hourly aggregates, one point per hour */
|
|
827
1272
|
from_trends: boolean;
|
|
828
1273
|
series: components["schemas"]["MetricSeriesResource"][] | null;
|
|
829
1274
|
thresholds: components["schemas"]["ItemThresholdResource"][] | null;
|
|
@@ -839,7 +1284,7 @@ export interface components {
|
|
|
839
1284
|
};
|
|
840
1285
|
ServerResourcesResource: {
|
|
841
1286
|
interfaces: components["schemas"]["HostInterfaceResource"][] | null;
|
|
842
|
-
/** @description
|
|
1287
|
+
/** @description Hardware and system inventory collected automatically: CPU, memory, operating system and so on */
|
|
843
1288
|
inventory: {
|
|
844
1289
|
[key: string]: string;
|
|
845
1290
|
};
|
|
@@ -848,7 +1293,7 @@ export interface components {
|
|
|
848
1293
|
SnapshotResource: {
|
|
849
1294
|
agent_error: string;
|
|
850
1295
|
/**
|
|
851
|
-
* @description AGENT_DOWN
|
|
1296
|
+
* @description AGENT_DOWN means the agent is unreachable while the machine is still alive; UNREACHABLE means neither can be established
|
|
852
1297
|
* @enum {string}
|
|
853
1298
|
*/
|
|
854
1299
|
agent_reachability: "UNKNOWN" | "REACHABLE" | "AGENT_DOWN" | "UNREACHABLE";
|
|
@@ -868,6 +1313,46 @@ export interface components {
|
|
|
868
1313
|
TopItemListResponseBody: {
|
|
869
1314
|
items: components["schemas"]["TopItemResource"][] | null;
|
|
870
1315
|
};
|
|
1316
|
+
TemplateCatalogParameterResource: {
|
|
1317
|
+
/** @description The value that takes effect when the parameter is omitted. An empty string is a real default, not an absent one */
|
|
1318
|
+
default: string;
|
|
1319
|
+
/**
|
|
1320
|
+
* @description The shape of the accepted value. Surrounding whitespace is trimmed before the value is checked, and an omitted or empty value is replaced by `default` and not checked at all.
|
|
1321
|
+
*
|
|
1322
|
+
* - `string` — no constraint; empty is accepted
|
|
1323
|
+
* - `non_empty_string` — must not be empty once trimmed
|
|
1324
|
+
* - `percent` — a number in the **closed** interval 0 to 100; fractions are accepted
|
|
1325
|
+
* - `positive_number` — a number **strictly** greater than 0; fractions are accepted
|
|
1326
|
+
* - `port` — an integer from 1 to 65535 inclusive; `8080/tcp` is not a port
|
|
1327
|
+
* - `host` — an IP address, or a hostname of at most 255 characters whose dot-separated labels are at most 63 characters of `A-Z a-z 0-9 - _` and neither begin nor end with `-`. A single label such as `localhost` is accepted, as is a trailing dot
|
|
1328
|
+
* - `ip_or_empty` — an IP address, or empty to mean "not specified"
|
|
1329
|
+
* - `regexp` — must compile as a **Go RE2** pattern. RE2 has no backreferences and no lookaround, so a pattern that a browser's `new RegExp()` accepts may still be rejected here. Validating client-side narrows the gap but does not close it
|
|
1330
|
+
* @enum {string}
|
|
1331
|
+
*/
|
|
1332
|
+
kind: "string" | "non_empty_string" | "percent" | "positive_number" | "port" | "host" | "ip_or_empty" | "regexp";
|
|
1333
|
+
/** @description The key to use in `template_bindings[].parameters`. It is not the Zabbix macro name, which is internal and changes between Zabbix versions */
|
|
1334
|
+
name: string;
|
|
1335
|
+
/** @description Independent of `default`. The three NGINX connection parameters carry a default and are still required, because the template's own default (localhost:80/basic_status) is almost never right */
|
|
1336
|
+
required: boolean;
|
|
1337
|
+
/** @description Supplied in clear text and never returned. A configured one is reported by name only, through `configured_secret_parameters` on the bound template. When updating a machine that already has one stored, omit it to keep the stored value and supply it only to replace it — a caller cannot read it back, so requiring it on every write would make resuming collection impossible */
|
|
1338
|
+
secret: boolean;
|
|
1339
|
+
};
|
|
1340
|
+
TemplateCatalogEntryResource: {
|
|
1341
|
+
/** @description Exactly one template with this set must be bound to every machine. Binding none enrolls a machine that can never alert; binding both loads the Linux and Windows items onto one machine, half of which must fail */
|
|
1342
|
+
is_base: boolean;
|
|
1343
|
+
/** @description False means the template collects without an agent on the machine — ICMP_PING is pinged by the Zabbix server, PROXMOX_VE is polled over the PVE API */
|
|
1344
|
+
needs_agent: boolean;
|
|
1345
|
+
/** @description In declaration order — connection parameters first, thresholds after — and meant to be rendered in that order. It is deliberately not alphabetical, which would split a template's connection parameters apart with thresholds between them even though they only make sense filled in together */
|
|
1346
|
+
parameters: components["schemas"]["TemplateCatalogParameterResource"][] | null;
|
|
1347
|
+
/** @description Templates that must be bound alongside this one. Values are `template_key`s */
|
|
1348
|
+
requires: string[] | null;
|
|
1349
|
+
/** @description Whether this template may be bound when `agent_mode` is ACTIVE. It already combines both reasons it may not be — no active variant exists, or this deployment does not have one installed — because the two are rejected identically and call for the same fix */
|
|
1350
|
+
supports_active_mode: boolean;
|
|
1351
|
+
template_key: string;
|
|
1352
|
+
};
|
|
1353
|
+
TemplateCatalogResponseBody: {
|
|
1354
|
+
items: components["schemas"]["TemplateCatalogEntryResource"][] | null;
|
|
1355
|
+
};
|
|
871
1356
|
ServerTemplateResource: {
|
|
872
1357
|
configured_secret_parameters: string[] | null;
|
|
873
1358
|
parameters: {
|
|
@@ -892,7 +1377,7 @@ export interface components {
|
|
|
892
1377
|
id: string;
|
|
893
1378
|
last_error: string;
|
|
894
1379
|
/**
|
|
895
|
-
* @description
|
|
1380
|
+
* @description Consult `last_error` when this is FAILED
|
|
896
1381
|
* @enum {string}
|
|
897
1382
|
*/
|
|
898
1383
|
monitoring_status: "PENDING" | "ACTIVE" | "DISABLED" | "FAILED";
|
|
@@ -902,30 +1387,34 @@ export interface components {
|
|
|
902
1387
|
templates: components["schemas"]["ServerTemplateResource"][] | null;
|
|
903
1388
|
/** Format: date-time */
|
|
904
1389
|
updated_at: string;
|
|
905
|
-
/** @description agent
|
|
1390
|
+
/** @description The Hostname in the agent configuration must match this value; active checks identify the machine by it */
|
|
906
1391
|
zabbix_host_name: string;
|
|
907
1392
|
};
|
|
908
1393
|
LengthAwarePageServerResource: {
|
|
909
|
-
/** @description
|
|
1394
|
+
/** @description The records in this page */
|
|
910
1395
|
items: components["schemas"]["ServerResource"][];
|
|
911
1396
|
/**
|
|
912
1397
|
* Format: int64
|
|
913
|
-
* @description
|
|
1398
|
+
* @description Maximum records per page, echoing the request
|
|
914
1399
|
*/
|
|
915
1400
|
limit: number;
|
|
916
1401
|
/**
|
|
917
1402
|
* Format: int64
|
|
918
|
-
* @description
|
|
1403
|
+
* @description Number of records skipped, echoing the request
|
|
919
1404
|
*/
|
|
920
1405
|
offset: number;
|
|
921
1406
|
/**
|
|
922
1407
|
* Format: int64
|
|
923
|
-
* @description
|
|
1408
|
+
* @description Total number of matches, not just this page
|
|
924
1409
|
*/
|
|
925
1410
|
total: number;
|
|
926
1411
|
};
|
|
927
1412
|
TemplateBindingRequest: {
|
|
928
|
-
/**
|
|
1413
|
+
/**
|
|
1414
|
+
* @description Parameters declared by the template, keyed by `name` from `GET /templates`. This is a full replacement: a parameter that is omitted takes the `default` reported there, so send back the whole `parameters` map read from the machine rather than only the field being changed.
|
|
1415
|
+
*
|
|
1416
|
+
* Secret parameters are the one exception, because they are never returned and so cannot be sent back. Omit one to keep the value already stored, and supply it only to replace it. An empty or blank value counts as omitted.
|
|
1417
|
+
*/
|
|
929
1418
|
parameters?: {
|
|
930
1419
|
[key: string]: string;
|
|
931
1420
|
};
|
|
@@ -937,13 +1426,13 @@ export interface components {
|
|
|
937
1426
|
/** @enum {string} */
|
|
938
1427
|
address_kind: "ip" | "dns";
|
|
939
1428
|
/**
|
|
940
|
-
* @description
|
|
1429
|
+
* @description Empty selects passive mode, which requires the least agent-side configuration
|
|
941
1430
|
* @enum {string}
|
|
942
1431
|
*/
|
|
943
1432
|
agent_mode?: "PASSIVE" | "ACTIVE";
|
|
944
1433
|
/**
|
|
945
1434
|
* Format: int64
|
|
946
|
-
* @description 0
|
|
1435
|
+
* @description 0 uses the default of 10050
|
|
947
1436
|
*/
|
|
948
1437
|
agent_port?: number;
|
|
949
1438
|
description?: string;
|
|
@@ -951,14 +1440,14 @@ export interface components {
|
|
|
951
1440
|
template_bindings?: components["schemas"]["TemplateBindingRequest"][] | null;
|
|
952
1441
|
};
|
|
953
1442
|
EnrollmentResource: {
|
|
954
|
-
/** @description
|
|
1443
|
+
/** @description Includes the PSK. Like `tls_psk`, it is returned only this once */
|
|
955
1444
|
install_command: string;
|
|
956
1445
|
install_script_url: string;
|
|
957
|
-
/** @description
|
|
1446
|
+
/** @description **Returned only this once** */
|
|
958
1447
|
tls_psk: string;
|
|
959
1448
|
tls_psk_identity: string;
|
|
960
1449
|
zabbix_host_name: string;
|
|
961
|
-
/** @description
|
|
1450
|
+
/** @description The Server and ServerActive values for the agent configuration */
|
|
962
1451
|
zabbix_server_address: string;
|
|
963
1452
|
};
|
|
964
1453
|
ServerEnrollmentResponseBody: {
|
|
@@ -968,12 +1457,12 @@ export interface components {
|
|
|
968
1457
|
UpdateServerRequestBody: {
|
|
969
1458
|
address?: string;
|
|
970
1459
|
/**
|
|
971
|
-
* @description
|
|
1460
|
+
* @description Must be supplied together with `address` when changing the address
|
|
972
1461
|
* @enum {string}
|
|
973
1462
|
*/
|
|
974
1463
|
address_kind?: "ip" | "dns";
|
|
975
1464
|
/**
|
|
976
|
-
* @description
|
|
1465
|
+
* @description Changing the collection mode rebinds every template to the corresponding variant
|
|
977
1466
|
* @enum {string}
|
|
978
1467
|
*/
|
|
979
1468
|
agent_mode?: "PASSIVE" | "ACTIVE";
|
|
@@ -989,7 +1478,7 @@ export interface components {
|
|
|
989
1478
|
error: string;
|
|
990
1479
|
/**
|
|
991
1480
|
* Format: int64
|
|
992
|
-
* @description
|
|
1481
|
+
* @description Index of the failed step, counting from 1. 0 when healthy
|
|
993
1482
|
*/
|
|
994
1483
|
failed_step: number;
|
|
995
1484
|
healthy: boolean;
|
|
@@ -999,7 +1488,7 @@ export interface components {
|
|
|
999
1488
|
response_time_seconds: number;
|
|
1000
1489
|
};
|
|
1001
1490
|
WebCheckStepResource: {
|
|
1002
|
-
/** @description
|
|
1491
|
+
/** @description Status code expression, such as 200 or 200,301-302 */
|
|
1003
1492
|
expected_status_codes: string;
|
|
1004
1493
|
follow_redirects: boolean;
|
|
1005
1494
|
name: string;
|
|
@@ -1014,10 +1503,14 @@ export interface components {
|
|
|
1014
1503
|
last_error: string;
|
|
1015
1504
|
/** Format: int64 */
|
|
1016
1505
|
response_time_threshold_seconds: number;
|
|
1017
|
-
|
|
1506
|
+
/** @description null means the check has not completed a round yet. A zero value would present "not yet known" as "0 seconds, status code 0" */
|
|
1507
|
+
result: components["schemas"]["WebCheckResultResource"] | null;
|
|
1018
1508
|
/** Format: int64 */
|
|
1019
1509
|
retries: number;
|
|
1020
|
-
/**
|
|
1510
|
+
/**
|
|
1511
|
+
* Format: uuid
|
|
1512
|
+
* @description The machine this check is attached to. Empty for a project-level check, which is not tied to any machine
|
|
1513
|
+
*/
|
|
1021
1514
|
server_id: string;
|
|
1022
1515
|
steps: components["schemas"]["WebCheckStepResource"][] | null;
|
|
1023
1516
|
/** @enum {string} */
|
|
@@ -1026,23 +1519,23 @@ export interface components {
|
|
|
1026
1519
|
timeout_seconds: number;
|
|
1027
1520
|
};
|
|
1028
1521
|
WebCheckStepRequest: {
|
|
1029
|
-
/** @description
|
|
1522
|
+
/** @description Status code expression, such as 200 or 200,301-302. Empty disables status code checking */
|
|
1030
1523
|
expected_status_codes?: string;
|
|
1031
1524
|
follow_redirects?: boolean;
|
|
1032
1525
|
name: string;
|
|
1033
|
-
/** @description
|
|
1526
|
+
/** @description A string that must appear in the response body */
|
|
1034
1527
|
required_pattern?: string;
|
|
1035
1528
|
url: string;
|
|
1036
1529
|
};
|
|
1037
1530
|
PutWebCheckRequestBody: {
|
|
1038
1531
|
/**
|
|
1039
1532
|
* Format: int64
|
|
1040
|
-
* @description 0
|
|
1533
|
+
* @description 0 uses the default
|
|
1041
1534
|
*/
|
|
1042
1535
|
interval_seconds?: number;
|
|
1043
1536
|
/**
|
|
1044
1537
|
* Format: int64
|
|
1045
|
-
* @description
|
|
1538
|
+
* @description Slower than this counts as slow. 0 disables the response time check
|
|
1046
1539
|
*/
|
|
1047
1540
|
response_time_threshold_seconds?: number;
|
|
1048
1541
|
/** Format: int64 */
|
|
@@ -1059,19 +1552,19 @@ export interface components {
|
|
|
1059
1552
|
downtime_seconds: number;
|
|
1060
1553
|
/**
|
|
1061
1554
|
* Format: int64
|
|
1062
|
-
* @description
|
|
1555
|
+
* @description A negative value means the budget for this period is already exhausted
|
|
1063
1556
|
*/
|
|
1064
1557
|
error_budget_seconds: number;
|
|
1065
1558
|
/**
|
|
1066
1559
|
* Format: int64
|
|
1067
|
-
* @description
|
|
1560
|
+
* @description The portion excluded by planned maintenance
|
|
1068
1561
|
*/
|
|
1069
1562
|
excluded_downtime_seconds: number;
|
|
1070
1563
|
/** Format: date-time */
|
|
1071
1564
|
period_from: string;
|
|
1072
1565
|
/** Format: date-time */
|
|
1073
1566
|
period_to: string;
|
|
1074
|
-
/** @description
|
|
1567
|
+
/** @description Empty means this row covers the project as a whole */
|
|
1075
1568
|
server_id: string;
|
|
1076
1569
|
/** Format: double */
|
|
1077
1570
|
sli_percent: number;
|
|
@@ -1088,7 +1581,7 @@ export interface components {
|
|
|
1088
1581
|
start_time_seconds: number;
|
|
1089
1582
|
/**
|
|
1090
1583
|
* Format: int64
|
|
1091
|
-
* @description
|
|
1584
|
+
* @description Bitmap of weekdays, **Monday is the lowest bit**, using the same encoding as maintenance windows
|
|
1092
1585
|
*/
|
|
1093
1586
|
weekdays: number;
|
|
1094
1587
|
};
|
|
@@ -1103,13 +1596,13 @@ export interface components {
|
|
|
1103
1596
|
period: "DAILY" | "WEEKLY" | "MONTHLY" | "QUARTERLY" | "ANNUALLY";
|
|
1104
1597
|
/** Format: uuid */
|
|
1105
1598
|
project_id: string;
|
|
1106
|
-
/** @description
|
|
1599
|
+
/** @description Empty means a 24x7 commitment */
|
|
1107
1600
|
schedule: components["schemas"]["ScheduleWindowResource"][] | null;
|
|
1108
1601
|
/** Format: uuid */
|
|
1109
1602
|
slo_id: string;
|
|
1110
1603
|
/**
|
|
1111
1604
|
* Format: double
|
|
1112
|
-
* @description
|
|
1605
|
+
* @description Target availability, such as 99.9
|
|
1113
1606
|
*/
|
|
1114
1607
|
slo_percent: number;
|
|
1115
1608
|
/** @enum {string} */
|
|
@@ -1123,7 +1616,7 @@ export interface components {
|
|
|
1123
1616
|
start_time_seconds?: number;
|
|
1124
1617
|
/**
|
|
1125
1618
|
* Format: int64
|
|
1126
|
-
* @description
|
|
1619
|
+
* @description Bitmap of weekdays, **Monday is the lowest bit** (1 = Monday … 64 = Sunday)
|
|
1127
1620
|
*/
|
|
1128
1621
|
weekdays: number;
|
|
1129
1622
|
};
|
|
@@ -1134,7 +1627,7 @@ export interface components {
|
|
|
1134
1627
|
min_severity: "ANY" | "INFORMATION" | "WARNING" | "AVERAGE" | "HIGH" | "DISASTER";
|
|
1135
1628
|
name: string;
|
|
1136
1629
|
/**
|
|
1137
|
-
* @description
|
|
1630
|
+
* @description Empty selects monthly
|
|
1138
1631
|
* @enum {string}
|
|
1139
1632
|
*/
|
|
1140
1633
|
period?: "DAILY" | "WEEKLY" | "MONTHLY" | "QUARTERLY" | "ANNUALLY";
|
|
@@ -1143,11 +1636,399 @@ export interface components {
|
|
|
1143
1636
|
slo_id: string;
|
|
1144
1637
|
/**
|
|
1145
1638
|
* Format: double
|
|
1146
|
-
* @description
|
|
1639
|
+
* @description Target availability, such as 99.9. At most four decimal places
|
|
1147
1640
|
*/
|
|
1148
1641
|
slo_percent: number;
|
|
1149
|
-
/** @description
|
|
1642
|
+
/** @description Determines the boundaries of each reporting period, that is, the moment each period begins */
|
|
1643
|
+
timezone?: string;
|
|
1644
|
+
};
|
|
1645
|
+
StatusPageResource: {
|
|
1646
|
+
/** @description #RRGGBB */
|
|
1647
|
+
brand_color: string;
|
|
1648
|
+
/** Format: date-time */
|
|
1649
|
+
created_at: string;
|
|
1650
|
+
/** @description The custom domain bound to this page. Empty means it is served only at /{slug} under the shared domain */
|
|
1651
|
+
custom_domain: string;
|
|
1652
|
+
footer_text: string;
|
|
1653
|
+
headline: string;
|
|
1654
|
+
logo_url: string;
|
|
1655
|
+
name: string;
|
|
1656
|
+
/** @description The address this page is served at: the custom domain if one is bound, otherwise the shared domain with the slug, otherwise the shared domain with the project id */
|
|
1657
|
+
public_url: string;
|
|
1658
|
+
published: boolean;
|
|
1659
|
+
/** @description Whether search engines may index the page */
|
|
1660
|
+
search_engine_index: boolean;
|
|
1661
|
+
/** @description The readable address segment, empty when none is set. The page is always reachable at /<project id> regardless */
|
|
1662
|
+
slug: string;
|
|
1663
|
+
/** Format: uuid */
|
|
1664
|
+
status_page_id: string;
|
|
1665
|
+
support_url: string;
|
|
1666
|
+
/** @enum {string} */
|
|
1667
|
+
theme: "AUTO" | "LIGHT" | "DARK";
|
|
1668
|
+
/** @description Determines where the day boundary falls on the availability bar */
|
|
1669
|
+
timezone: string;
|
|
1670
|
+
/** Format: date-time */
|
|
1671
|
+
updated_at: string;
|
|
1672
|
+
/**
|
|
1673
|
+
* Format: int64
|
|
1674
|
+
* @description Number of days covered by the availability bar
|
|
1675
|
+
*/
|
|
1676
|
+
uptime_days: number;
|
|
1677
|
+
/** @description The text shown on the support link. Empty means the page default is used */
|
|
1678
|
+
support_label: string;
|
|
1679
|
+
};
|
|
1680
|
+
PutStatusPageRequestBody: {
|
|
1681
|
+
/** @description #RRGGBB. Applied to the page styling; only a strict six-digit hexadecimal value is accepted */
|
|
1682
|
+
brand_color?: string;
|
|
1683
|
+
/** @description Read-only here. Bind a custom domain through PUT /status-page/domain, which verifies ownership first; a value sent here is ignored */
|
|
1684
|
+
custom_domain?: string;
|
|
1685
|
+
/** @description The line of free-form text in the page footer. Plain text */
|
|
1686
|
+
footer_text?: string;
|
|
1687
|
+
/** @description The line shown below the title */
|
|
1688
|
+
headline?: string;
|
|
1689
|
+
logo_url?: string;
|
|
1690
|
+
/** @description Page title */
|
|
1691
|
+
name: string;
|
|
1692
|
+
/**
|
|
1693
|
+
* @description While false, the public address returns 404. Unpublished by default
|
|
1694
|
+
* @default false
|
|
1695
|
+
*/
|
|
1696
|
+
published?: boolean;
|
|
1697
|
+
/**
|
|
1698
|
+
* @description Not indexed by default. Once a page has been crawled, switching back does not remove copies already held in third-party indexes
|
|
1699
|
+
* @default false
|
|
1700
|
+
*/
|
|
1701
|
+
search_engine_index?: boolean;
|
|
1702
|
+
/** @description An optional readable address segment under the shared domain. Lowercase letters, digits and hyphens; globally unique. Leave it empty and the page is served at /<project id>, which needs no configuration and cannot be taken by anyone else */
|
|
1703
|
+
slug?: string;
|
|
1704
|
+
support_url?: string;
|
|
1705
|
+
/**
|
|
1706
|
+
* @default AUTO
|
|
1707
|
+
* @enum {string}
|
|
1708
|
+
*/
|
|
1709
|
+
theme?: "AUTO" | "LIGHT" | "DARK";
|
|
1710
|
+
/** @description IANA name. Empty selects UTC */
|
|
1150
1711
|
timezone?: string;
|
|
1712
|
+
/**
|
|
1713
|
+
* Format: int64
|
|
1714
|
+
* @default 90
|
|
1715
|
+
*/
|
|
1716
|
+
uptime_days?: number;
|
|
1717
|
+
/** @description The text shown on the support link. Empty uses the page default. Different products call this different things — help centre, submit a ticket, support */
|
|
1718
|
+
support_label?: string;
|
|
1719
|
+
};
|
|
1720
|
+
PutStatusPageOrderRequestBody: {
|
|
1721
|
+
items: components["schemas"]["StatusPageOrderItem"][];
|
|
1722
|
+
};
|
|
1723
|
+
/** @description Exactly one of the two: `group_id` marks this position as a group, `component_id` as an ungrouped component */
|
|
1724
|
+
StatusPageOrderItem: {
|
|
1725
|
+
/** Format: uuid */
|
|
1726
|
+
component_id?: string;
|
|
1727
|
+
/** Format: uuid */
|
|
1728
|
+
group_id?: string;
|
|
1729
|
+
};
|
|
1730
|
+
PutStatusPageGroupOrderRequestBody: {
|
|
1731
|
+
component_ids: string[];
|
|
1732
|
+
};
|
|
1733
|
+
StatusPageGroupResource: {
|
|
1734
|
+
/** @description Whether the group is collapsed by default on the page */
|
|
1735
|
+
collapsed: boolean;
|
|
1736
|
+
/** Format: date-time */
|
|
1737
|
+
created_at: string;
|
|
1738
|
+
description: string;
|
|
1739
|
+
/** Format: uuid */
|
|
1740
|
+
group_id: string;
|
|
1741
|
+
name: string;
|
|
1742
|
+
/** Format: int64 */
|
|
1743
|
+
position: number;
|
|
1744
|
+
};
|
|
1745
|
+
StatusPageGroupListResponseBody: {
|
|
1746
|
+
data: components["schemas"]["StatusPageGroupResource"][];
|
|
1747
|
+
};
|
|
1748
|
+
PutStatusPageGroupRequestBody: {
|
|
1749
|
+
/** @default true */
|
|
1750
|
+
collapsed?: boolean;
|
|
1751
|
+
description?: string;
|
|
1752
|
+
name: string;
|
|
1753
|
+
};
|
|
1754
|
+
StatusPageComponentResource: {
|
|
1755
|
+
/** @enum {string} */
|
|
1756
|
+
auto_status_min_severity: "ANY" | "INFORMATION" | "WARNING" | "AVERAGE" | "HIGH" | "DISASTER";
|
|
1757
|
+
/** Format: uuid */
|
|
1758
|
+
component_id: string;
|
|
1759
|
+
/** Format: date-time */
|
|
1760
|
+
created_at: string;
|
|
1761
|
+
/**
|
|
1762
|
+
* @description The status currently shown to the public. OPERATIONAL means normal
|
|
1763
|
+
* @enum {string}
|
|
1764
|
+
*/
|
|
1765
|
+
current_status: "OPERATIONAL" | "DEGRADED_PERFORMANCE" | "PARTIAL_OUTAGE" | "MAJOR_OUTAGE" | "UNDER_MAINTENANCE";
|
|
1766
|
+
description: string;
|
|
1767
|
+
/** @description Empty means ungrouped, placed directly at the top level of the page */
|
|
1768
|
+
group_id: string;
|
|
1769
|
+
name: string;
|
|
1770
|
+
/** @description Hide this row while everything is normal */
|
|
1771
|
+
only_show_if_degraded: boolean;
|
|
1772
|
+
/** Format: int64 */
|
|
1773
|
+
position: number;
|
|
1774
|
+
/** @description Whether the availability bar is shown. Components with this disabled are also excluded from the aggregate of their group */
|
|
1775
|
+
show_uptime: boolean;
|
|
1776
|
+
/**
|
|
1777
|
+
* Format: date-time
|
|
1778
|
+
* @description The moment this component started being covered. Earlier days are shown as unmeasured rather than operational
|
|
1779
|
+
*/
|
|
1780
|
+
started_on: string;
|
|
1781
|
+
/**
|
|
1782
|
+
* Format: double
|
|
1783
|
+
* @description Availability over the past `uptime_days` days
|
|
1784
|
+
*/
|
|
1785
|
+
uptime_percent: number;
|
|
1786
|
+
};
|
|
1787
|
+
StatusPageComponentListResponseBody: {
|
|
1788
|
+
data: components["schemas"]["StatusPageComponentResource"][];
|
|
1789
|
+
};
|
|
1790
|
+
PutStatusPageComponentRequestBody: {
|
|
1791
|
+
/**
|
|
1792
|
+
* @description Alerts below this severity do not change the status of this row
|
|
1793
|
+
* @default AVERAGE
|
|
1794
|
+
* @enum {string}
|
|
1795
|
+
*/
|
|
1796
|
+
auto_status_min_severity?: "ANY" | "INFORMATION" | "WARNING" | "AVERAGE" | "HIGH" | "DISASTER";
|
|
1797
|
+
description?: string;
|
|
1798
|
+
/**
|
|
1799
|
+
* Format: uuid
|
|
1800
|
+
* @description Empty leaves the component ungrouped
|
|
1801
|
+
*/
|
|
1802
|
+
group_id?: string;
|
|
1803
|
+
/** @description Customer-facing copy; appears verbatim on the public page */
|
|
1804
|
+
name: string;
|
|
1805
|
+
/** @default false */
|
|
1806
|
+
only_show_if_degraded?: boolean;
|
|
1807
|
+
/** @default true */
|
|
1808
|
+
show_uptime?: boolean;
|
|
1809
|
+
/**
|
|
1810
|
+
* Format: date-time
|
|
1811
|
+
* @description Meaningful only at creation and immutable afterwards. Empty selects the current moment
|
|
1812
|
+
*/
|
|
1813
|
+
started_on?: string;
|
|
1814
|
+
};
|
|
1815
|
+
StatusPageComponentSourceServer: {
|
|
1816
|
+
/** Format: uuid */
|
|
1817
|
+
server_id: string;
|
|
1818
|
+
};
|
|
1819
|
+
StatusPageComponentSourceWebCheck: {
|
|
1820
|
+
/**
|
|
1821
|
+
* @description Whether the checked address is shown on the public page
|
|
1822
|
+
* @default false
|
|
1823
|
+
*/
|
|
1824
|
+
show_url?: boolean;
|
|
1825
|
+
/** Format: uuid */
|
|
1826
|
+
web_check_id: string;
|
|
1827
|
+
};
|
|
1828
|
+
StatusPageComponentSourcesResource: {
|
|
1829
|
+
servers: components["schemas"]["StatusPageComponentSourceServer"][];
|
|
1830
|
+
web_checks: components["schemas"]["StatusPageComponentSourceWebCheck"][];
|
|
1831
|
+
};
|
|
1832
|
+
/** @description Submits the complete set; anything not listed is unbound */
|
|
1833
|
+
PutStatusPageComponentSourcesRequestBody: {
|
|
1834
|
+
servers?: components["schemas"]["StatusPageComponentSourceServer"][];
|
|
1835
|
+
web_checks?: components["schemas"]["StatusPageComponentSourceWebCheck"][];
|
|
1836
|
+
};
|
|
1837
|
+
/** @description A status transition of one component within one update. The component name is a snapshot taken at the time */
|
|
1838
|
+
StatusPageIncidentComponentResource: {
|
|
1839
|
+
/** Format: uuid */
|
|
1840
|
+
component_id: string;
|
|
1841
|
+
component_name: string;
|
|
1842
|
+
/** @enum {string} */
|
|
1843
|
+
new_status: "OPERATIONAL" | "DEGRADED_PERFORMANCE" | "PARTIAL_OUTAGE" | "MAJOR_OUTAGE" | "UNDER_MAINTENANCE";
|
|
1844
|
+
/** @enum {string} */
|
|
1845
|
+
old_status: "OPERATIONAL" | "DEGRADED_PERFORMANCE" | "PARTIAL_OUTAGE" | "MAJOR_OUTAGE" | "UNDER_MAINTENANCE";
|
|
1846
|
+
};
|
|
1847
|
+
StatusPageIncidentUpdateResource: {
|
|
1848
|
+
affected_components: components["schemas"]["StatusPageIncidentComponentResource"][] | null;
|
|
1849
|
+
/** @description Body text. Plain text */
|
|
1850
|
+
body: string;
|
|
1851
|
+
/** @enum {string} */
|
|
1852
|
+
incident_status: "INVESTIGATING" | "IDENTIFIED" | "MONITORING" | "RESOLVED";
|
|
1853
|
+
/** Format: date-time */
|
|
1854
|
+
published_at: string;
|
|
1855
|
+
/** Format: uuid */
|
|
1856
|
+
update_id: string;
|
|
1857
|
+
};
|
|
1858
|
+
StatusPageIncidentResource: {
|
|
1859
|
+
/** @enum {string} */
|
|
1860
|
+
impact: "NONE" | "MINOR" | "MAJOR" | "CRITICAL";
|
|
1861
|
+
/** Format: uuid */
|
|
1862
|
+
incident_id: string;
|
|
1863
|
+
/** @enum {string} */
|
|
1864
|
+
incident_status: "INVESTIGATING" | "IDENTIFIED" | "MONITORING" | "RESOLVED";
|
|
1865
|
+
name: string;
|
|
1866
|
+
/** Format: date-time */
|
|
1867
|
+
published_at: string;
|
|
1868
|
+
/** Format: date-time */
|
|
1869
|
+
resolved_at: string | null;
|
|
1870
|
+
/**
|
|
1871
|
+
* Format: date-time
|
|
1872
|
+
* @description When the incident began, not when the notice was published
|
|
1873
|
+
*/
|
|
1874
|
+
started_at: string;
|
|
1875
|
+
/** @description Most recently published first */
|
|
1876
|
+
updates: components["schemas"]["StatusPageIncidentUpdateResource"][] | null;
|
|
1877
|
+
};
|
|
1878
|
+
LengthAwarePageStatusPageIncidentResource: {
|
|
1879
|
+
data: components["schemas"]["StatusPageIncidentResource"][];
|
|
1880
|
+
/** Format: int64 */
|
|
1881
|
+
limit: number;
|
|
1882
|
+
/** Format: int64 */
|
|
1883
|
+
offset: number;
|
|
1884
|
+
/** Format: int64 */
|
|
1885
|
+
total: number;
|
|
1886
|
+
};
|
|
1887
|
+
StatusPageIncidentComponentRequest: {
|
|
1888
|
+
/** Format: uuid */
|
|
1889
|
+
component_id: string;
|
|
1890
|
+
/**
|
|
1891
|
+
* @description Empty returns this component to operational
|
|
1892
|
+
* @enum {string}
|
|
1893
|
+
*/
|
|
1894
|
+
status?: "OPERATIONAL" | "DEGRADED_PERFORMANCE" | "PARTIAL_OUTAGE" | "MAJOR_OUTAGE" | "UNDER_MAINTENANCE";
|
|
1895
|
+
};
|
|
1896
|
+
PublishStatusPageIncidentRequestBody: {
|
|
1897
|
+
/** @description Body of the first update. Plain text */
|
|
1898
|
+
body: string;
|
|
1899
|
+
components?: components["schemas"]["StatusPageIncidentComponentRequest"][];
|
|
1900
|
+
/**
|
|
1901
|
+
* @description Empty derives the impact from the affected components
|
|
1902
|
+
* @enum {string}
|
|
1903
|
+
*/
|
|
1904
|
+
impact?: "NONE" | "MINOR" | "MAJOR" | "CRITICAL";
|
|
1905
|
+
/**
|
|
1906
|
+
* @default INVESTIGATING
|
|
1907
|
+
* @enum {string}
|
|
1908
|
+
*/
|
|
1909
|
+
incident_status?: "INVESTIGATING" | "IDENTIFIED" | "MONITORING" | "RESOLVED";
|
|
1910
|
+
/** @description The public title */
|
|
1911
|
+
name: string;
|
|
1912
|
+
/**
|
|
1913
|
+
* Format: date-time
|
|
1914
|
+
* @description Empty selects the current moment. Backfilling a past incident sets it in the past
|
|
1915
|
+
*/
|
|
1916
|
+
published_at?: string;
|
|
1917
|
+
/**
|
|
1918
|
+
* Format: date-time
|
|
1919
|
+
* @description When the incident began. Empty uses the publication time
|
|
1920
|
+
*/
|
|
1921
|
+
started_at?: string;
|
|
1922
|
+
};
|
|
1923
|
+
PostStatusPageIncidentUpdateRequestBody: {
|
|
1924
|
+
/** @description Body text. Plain text */
|
|
1925
|
+
body: string;
|
|
1926
|
+
/** @description Lists only the components being changed by this update; those not listed keep their current status */
|
|
1927
|
+
components?: components["schemas"]["StatusPageIncidentComponentRequest"][];
|
|
1928
|
+
/**
|
|
1929
|
+
* @description Empty keeps the current stage. RESOLVED closes the notice and returns every affected component to operational
|
|
1930
|
+
* @enum {string}
|
|
1931
|
+
*/
|
|
1932
|
+
incident_status?: "INVESTIGATING" | "IDENTIFIED" | "MONITORING" | "RESOLVED";
|
|
1933
|
+
/** Format: date-time */
|
|
1934
|
+
published_at?: string;
|
|
1935
|
+
};
|
|
1936
|
+
StatusPageMaintenanceComponentResource: {
|
|
1937
|
+
/** Format: uuid */
|
|
1938
|
+
component_id: string;
|
|
1939
|
+
component_name: string;
|
|
1940
|
+
/** @enum {string} */
|
|
1941
|
+
component_status: "UNDER_MAINTENANCE" | "DEGRADED_PERFORMANCE";
|
|
1942
|
+
};
|
|
1943
|
+
StatusPageMaintenanceResource: {
|
|
1944
|
+
affected_components: components["schemas"]["StatusPageMaintenanceComponentResource"][] | null;
|
|
1945
|
+
/** @description Maintenance description. Plain text */
|
|
1946
|
+
body: string;
|
|
1947
|
+
/**
|
|
1948
|
+
* Format: date-time
|
|
1949
|
+
* @description When the maintenance actually finished
|
|
1950
|
+
*/
|
|
1951
|
+
completed_at: string | null;
|
|
1952
|
+
/** Format: uuid */
|
|
1953
|
+
maintenance_id: string;
|
|
1954
|
+
/** @enum {string} */
|
|
1955
|
+
maintenance_status: "SCHEDULED" | "IN_PROGRESS" | "COMPLETED" | "CANCELLED";
|
|
1956
|
+
name: string;
|
|
1957
|
+
/** Format: date-time */
|
|
1958
|
+
scheduled_for: string;
|
|
1959
|
+
/** Format: date-time */
|
|
1960
|
+
scheduled_until: string;
|
|
1961
|
+
/**
|
|
1962
|
+
* Format: date-time
|
|
1963
|
+
* @description When the maintenance actually started, which may differ from the scheduled time
|
|
1964
|
+
*/
|
|
1965
|
+
started_at: string | null;
|
|
1966
|
+
};
|
|
1967
|
+
LengthAwarePageStatusPageMaintenanceResource: {
|
|
1968
|
+
data: components["schemas"]["StatusPageMaintenanceResource"][];
|
|
1969
|
+
/** Format: int64 */
|
|
1970
|
+
limit: number;
|
|
1971
|
+
/** Format: int64 */
|
|
1972
|
+
offset: number;
|
|
1973
|
+
/** Format: int64 */
|
|
1974
|
+
total: number;
|
|
1975
|
+
};
|
|
1976
|
+
StatusPageMaintenanceComponentRequest: {
|
|
1977
|
+
/** Format: uuid */
|
|
1978
|
+
component_id: string;
|
|
1979
|
+
/**
|
|
1980
|
+
* @description How this component is shown while the maintenance runs. Neither value reduces availability
|
|
1981
|
+
* @default UNDER_MAINTENANCE
|
|
1982
|
+
* @enum {string}
|
|
1983
|
+
*/
|
|
1984
|
+
component_status?: "UNDER_MAINTENANCE" | "DEGRADED_PERFORMANCE";
|
|
1985
|
+
};
|
|
1986
|
+
ScheduleStatusPageMaintenanceRequestBody: {
|
|
1987
|
+
/** @description Maintenance description. Plain text */
|
|
1988
|
+
body: string;
|
|
1989
|
+
/** @description At least one. Maintenance that affects no component reads on the page as an announcement with no subject */
|
|
1990
|
+
components: components["schemas"]["StatusPageMaintenanceComponentRequest"][];
|
|
1991
|
+
name: string;
|
|
1992
|
+
/** Format: date-time */
|
|
1993
|
+
scheduled_for: string;
|
|
1994
|
+
/**
|
|
1995
|
+
* Format: date-time
|
|
1996
|
+
* @description Must be later than `scheduled_for`
|
|
1997
|
+
*/
|
|
1998
|
+
scheduled_until: string;
|
|
1999
|
+
};
|
|
2000
|
+
StatusPageDomainResource: {
|
|
2001
|
+
/**
|
|
2002
|
+
* Format: date-time
|
|
2003
|
+
* @description When the current certificate expires
|
|
2004
|
+
*/
|
|
2005
|
+
certificate_not_after: string | null;
|
|
2006
|
+
/**
|
|
2007
|
+
* @description NONE means no certificate has been requested for this domain yet
|
|
2008
|
+
* @enum {string}
|
|
2009
|
+
*/
|
|
2010
|
+
certificate_status: "NONE" | "PENDING" | "ACTIVE" | "FAILED";
|
|
2011
|
+
/** @description The bound custom domain. Empty means none is bound */
|
|
2012
|
+
domain: string;
|
|
2013
|
+
/** @description The value the domain must point at */
|
|
2014
|
+
expected_cname: string;
|
|
2015
|
+
/** @description Why the most recent issuance attempt failed. Empty when it did not */
|
|
2016
|
+
last_error: string;
|
|
2017
|
+
/** @description What the domain currently resolves to. Empty when it resolves to nothing */
|
|
2018
|
+
observed_cname: string;
|
|
2019
|
+
/** @description The address this page is served at, taking the custom domain into account */
|
|
2020
|
+
public_url: string;
|
|
2021
|
+
/** @description Whether the domain currently points at the status page */
|
|
2022
|
+
verified: boolean;
|
|
2023
|
+
/**
|
|
2024
|
+
* Format: date-time
|
|
2025
|
+
* @description When ownership was last confirmed
|
|
2026
|
+
*/
|
|
2027
|
+
verified_at: string | null;
|
|
2028
|
+
};
|
|
2029
|
+
PutStatusPageDomainRequestBody: {
|
|
2030
|
+
/** @description Your own domain, such as status.acme.com. It must already point at the status page by CNAME */
|
|
2031
|
+
domain: string;
|
|
1151
2032
|
};
|
|
1152
2033
|
};
|
|
1153
2034
|
responses: never;
|
|
@@ -1161,24 +2042,26 @@ export interface operations {
|
|
|
1161
2042
|
"list-incidents": {
|
|
1162
2043
|
parameters: {
|
|
1163
2044
|
query?: {
|
|
1164
|
-
/** @description
|
|
2045
|
+
/** @description Maximum number of records in this page */
|
|
1165
2046
|
limit?: number;
|
|
1166
|
-
/** @description
|
|
2047
|
+
/** @description Number of records to skip. For deeper paging, use the cursor-paged endpoint instead */
|
|
1167
2048
|
offset?: number;
|
|
1168
|
-
/** @description
|
|
2049
|
+
/** @description Restrict to a single machine */
|
|
1169
2050
|
server_id?: string;
|
|
2051
|
+
/** @description Restrict to a single web check */
|
|
2052
|
+
web_check_id?: string;
|
|
1170
2053
|
incident_status?: "PROBLEM" | "RESOLVED";
|
|
1171
|
-
/** @description
|
|
2054
|
+
/** @description Matches at or above this severity, not exactly this severity */
|
|
1172
2055
|
min_severity?: "NOT_CLASSIFIED" | "INFORMATION" | "WARNING" | "AVERAGE" | "HIGH" | "DISASTER";
|
|
1173
2056
|
started_after?: string;
|
|
1174
2057
|
started_before?: string;
|
|
1175
|
-
/** @description
|
|
2058
|
+
/** @description Incidents that **overlap** [active_from, active_to]. This is what you want when overlaying incident bands on a metric chart */
|
|
1176
2059
|
active_from?: string;
|
|
1177
2060
|
active_to?: string;
|
|
1178
|
-
/** @description
|
|
2061
|
+
/** @description Given as `key` or `key=value`, repeatable. Multiple tags are combined with AND */
|
|
1179
2062
|
tag?: string[] | null;
|
|
1180
2063
|
assignee_user_id?: string;
|
|
1181
|
-
/** @description
|
|
2064
|
+
/** @description Whether someone has finished handling it here. Independent of `incident_status` */
|
|
1182
2065
|
closed?: "true" | "false";
|
|
1183
2066
|
acknowledged?: "true" | "false";
|
|
1184
2067
|
unassigned?: "true" | "false";
|
|
@@ -1196,7 +2079,862 @@ export interface operations {
|
|
|
1196
2079
|
[name: string]: unknown;
|
|
1197
2080
|
};
|
|
1198
2081
|
content: {
|
|
1199
|
-
"application/json": components["schemas"]["LengthAwarePageIncidentResource"];
|
|
2082
|
+
"application/json": components["schemas"]["LengthAwarePageIncidentResource"];
|
|
2083
|
+
};
|
|
2084
|
+
};
|
|
2085
|
+
/** @description Error */
|
|
2086
|
+
default: {
|
|
2087
|
+
headers: {
|
|
2088
|
+
[name: string]: unknown;
|
|
2089
|
+
};
|
|
2090
|
+
content: {
|
|
2091
|
+
"application/json": components["schemas"]["Error"];
|
|
2092
|
+
};
|
|
2093
|
+
};
|
|
2094
|
+
};
|
|
2095
|
+
};
|
|
2096
|
+
"get-incident": {
|
|
2097
|
+
parameters: {
|
|
2098
|
+
query?: never;
|
|
2099
|
+
header?: never;
|
|
2100
|
+
path: {
|
|
2101
|
+
incidentId: string;
|
|
2102
|
+
};
|
|
2103
|
+
cookie?: never;
|
|
2104
|
+
};
|
|
2105
|
+
requestBody?: never;
|
|
2106
|
+
responses: {
|
|
2107
|
+
/** @description OK */
|
|
2108
|
+
200: {
|
|
2109
|
+
headers: {
|
|
2110
|
+
[name: string]: unknown;
|
|
2111
|
+
};
|
|
2112
|
+
content: {
|
|
2113
|
+
"application/json": components["schemas"]["IncidentResource"];
|
|
2114
|
+
};
|
|
2115
|
+
};
|
|
2116
|
+
/** @description Error */
|
|
2117
|
+
default: {
|
|
2118
|
+
headers: {
|
|
2119
|
+
[name: string]: unknown;
|
|
2120
|
+
};
|
|
2121
|
+
content: {
|
|
2122
|
+
"application/json": components["schemas"]["Error"];
|
|
2123
|
+
};
|
|
2124
|
+
};
|
|
2125
|
+
};
|
|
2126
|
+
};
|
|
2127
|
+
"acknowledge-incident": {
|
|
2128
|
+
parameters: {
|
|
2129
|
+
query?: never;
|
|
2130
|
+
header?: never;
|
|
2131
|
+
path: {
|
|
2132
|
+
incidentId: string;
|
|
2133
|
+
};
|
|
2134
|
+
cookie?: never;
|
|
2135
|
+
};
|
|
2136
|
+
requestBody: {
|
|
2137
|
+
content: {
|
|
2138
|
+
"application/json": components["schemas"]["AcknowledgeIncidentRequestBody"];
|
|
2139
|
+
};
|
|
2140
|
+
};
|
|
2141
|
+
responses: {
|
|
2142
|
+
/** @description OK */
|
|
2143
|
+
200: {
|
|
2144
|
+
headers: {
|
|
2145
|
+
[name: string]: unknown;
|
|
2146
|
+
};
|
|
2147
|
+
content: {
|
|
2148
|
+
"application/json": components["schemas"]["IncidentResource"];
|
|
2149
|
+
};
|
|
2150
|
+
};
|
|
2151
|
+
/** @description Error */
|
|
2152
|
+
default: {
|
|
2153
|
+
headers: {
|
|
2154
|
+
[name: string]: unknown;
|
|
2155
|
+
};
|
|
2156
|
+
content: {
|
|
2157
|
+
"application/json": components["schemas"]["Error"];
|
|
2158
|
+
};
|
|
2159
|
+
};
|
|
2160
|
+
};
|
|
2161
|
+
};
|
|
2162
|
+
"assign-incident": {
|
|
2163
|
+
parameters: {
|
|
2164
|
+
query?: never;
|
|
2165
|
+
header?: never;
|
|
2166
|
+
path: {
|
|
2167
|
+
incidentId: string;
|
|
2168
|
+
};
|
|
2169
|
+
cookie?: never;
|
|
2170
|
+
};
|
|
2171
|
+
requestBody: {
|
|
2172
|
+
content: {
|
|
2173
|
+
"application/json": components["schemas"]["AssignIncidentRequestBody"];
|
|
2174
|
+
};
|
|
2175
|
+
};
|
|
2176
|
+
responses: {
|
|
2177
|
+
/** @description OK */
|
|
2178
|
+
200: {
|
|
2179
|
+
headers: {
|
|
2180
|
+
[name: string]: unknown;
|
|
2181
|
+
};
|
|
2182
|
+
content: {
|
|
2183
|
+
"application/json": components["schemas"]["IncidentResource"];
|
|
2184
|
+
};
|
|
2185
|
+
};
|
|
2186
|
+
/** @description Error */
|
|
2187
|
+
default: {
|
|
2188
|
+
headers: {
|
|
2189
|
+
[name: string]: unknown;
|
|
2190
|
+
};
|
|
2191
|
+
content: {
|
|
2192
|
+
"application/json": components["schemas"]["Error"];
|
|
2193
|
+
};
|
|
2194
|
+
};
|
|
2195
|
+
};
|
|
2196
|
+
};
|
|
2197
|
+
"close-incident": {
|
|
2198
|
+
parameters: {
|
|
2199
|
+
query?: never;
|
|
2200
|
+
header?: never;
|
|
2201
|
+
path: {
|
|
2202
|
+
incidentId: string;
|
|
2203
|
+
};
|
|
2204
|
+
cookie?: never;
|
|
2205
|
+
};
|
|
2206
|
+
requestBody: {
|
|
2207
|
+
content: {
|
|
2208
|
+
"application/json": components["schemas"]["CloseIncidentRequestBody"];
|
|
2209
|
+
};
|
|
2210
|
+
};
|
|
2211
|
+
responses: {
|
|
2212
|
+
/** @description OK */
|
|
2213
|
+
200: {
|
|
2214
|
+
headers: {
|
|
2215
|
+
[name: string]: unknown;
|
|
2216
|
+
};
|
|
2217
|
+
content: {
|
|
2218
|
+
"application/json": components["schemas"]["IncidentResource"];
|
|
2219
|
+
};
|
|
2220
|
+
};
|
|
2221
|
+
/** @description Error */
|
|
2222
|
+
default: {
|
|
2223
|
+
headers: {
|
|
2224
|
+
[name: string]: unknown;
|
|
2225
|
+
};
|
|
2226
|
+
content: {
|
|
2227
|
+
"application/json": components["schemas"]["Error"];
|
|
2228
|
+
};
|
|
2229
|
+
};
|
|
2230
|
+
};
|
|
2231
|
+
};
|
|
2232
|
+
"add-incident-comment": {
|
|
2233
|
+
parameters: {
|
|
2234
|
+
query?: never;
|
|
2235
|
+
header?: never;
|
|
2236
|
+
path: {
|
|
2237
|
+
incidentId: string;
|
|
2238
|
+
};
|
|
2239
|
+
cookie?: never;
|
|
2240
|
+
};
|
|
2241
|
+
requestBody: {
|
|
2242
|
+
content: {
|
|
2243
|
+
"application/json": components["schemas"]["AddCommentRequestBody"];
|
|
2244
|
+
};
|
|
2245
|
+
};
|
|
2246
|
+
responses: {
|
|
2247
|
+
/** @description OK */
|
|
2248
|
+
200: {
|
|
2249
|
+
headers: {
|
|
2250
|
+
[name: string]: unknown;
|
|
2251
|
+
};
|
|
2252
|
+
content: {
|
|
2253
|
+
"application/json": components["schemas"]["IncidentActivityResource"];
|
|
2254
|
+
};
|
|
2255
|
+
};
|
|
2256
|
+
/** @description Error */
|
|
2257
|
+
default: {
|
|
2258
|
+
headers: {
|
|
2259
|
+
[name: string]: unknown;
|
|
2260
|
+
};
|
|
2261
|
+
content: {
|
|
2262
|
+
"application/json": components["schemas"]["Error"];
|
|
2263
|
+
};
|
|
2264
|
+
};
|
|
2265
|
+
};
|
|
2266
|
+
};
|
|
2267
|
+
"set-incident-following": {
|
|
2268
|
+
parameters: {
|
|
2269
|
+
query?: never;
|
|
2270
|
+
header?: never;
|
|
2271
|
+
path: {
|
|
2272
|
+
incidentId: string;
|
|
2273
|
+
};
|
|
2274
|
+
cookie?: never;
|
|
2275
|
+
};
|
|
2276
|
+
requestBody: {
|
|
2277
|
+
content: {
|
|
2278
|
+
"application/json": components["schemas"]["SetFollowingRequestBody"];
|
|
2279
|
+
};
|
|
2280
|
+
};
|
|
2281
|
+
responses: {
|
|
2282
|
+
/** @description OK */
|
|
2283
|
+
200: {
|
|
2284
|
+
headers: {
|
|
2285
|
+
[name: string]: unknown;
|
|
2286
|
+
};
|
|
2287
|
+
content: {
|
|
2288
|
+
"application/json": components["schemas"]["IncidentResource"];
|
|
2289
|
+
};
|
|
2290
|
+
};
|
|
2291
|
+
/** @description Error */
|
|
2292
|
+
default: {
|
|
2293
|
+
headers: {
|
|
2294
|
+
[name: string]: unknown;
|
|
2295
|
+
};
|
|
2296
|
+
content: {
|
|
2297
|
+
"application/json": components["schemas"]["Error"];
|
|
2298
|
+
};
|
|
2299
|
+
};
|
|
2300
|
+
};
|
|
2301
|
+
};
|
|
2302
|
+
"reopen-incident": {
|
|
2303
|
+
parameters: {
|
|
2304
|
+
query?: never;
|
|
2305
|
+
header?: never;
|
|
2306
|
+
path: {
|
|
2307
|
+
incidentId: string;
|
|
2308
|
+
};
|
|
2309
|
+
cookie?: never;
|
|
2310
|
+
};
|
|
2311
|
+
requestBody?: never;
|
|
2312
|
+
responses: {
|
|
2313
|
+
/** @description OK */
|
|
2314
|
+
200: {
|
|
2315
|
+
headers: {
|
|
2316
|
+
[name: string]: unknown;
|
|
2317
|
+
};
|
|
2318
|
+
content: {
|
|
2319
|
+
"application/json": components["schemas"]["IncidentResource"];
|
|
2320
|
+
};
|
|
2321
|
+
};
|
|
2322
|
+
/** @description Error */
|
|
2323
|
+
default: {
|
|
2324
|
+
headers: {
|
|
2325
|
+
[name: string]: unknown;
|
|
2326
|
+
};
|
|
2327
|
+
content: {
|
|
2328
|
+
"application/json": components["schemas"]["Error"];
|
|
2329
|
+
};
|
|
2330
|
+
};
|
|
2331
|
+
};
|
|
2332
|
+
};
|
|
2333
|
+
"list-incident-timeline": {
|
|
2334
|
+
parameters: {
|
|
2335
|
+
query?: {
|
|
2336
|
+
limit?: number;
|
|
2337
|
+
/** @description The `next_cursor` returned by the previous page. Empty starts from the beginning */
|
|
2338
|
+
cursor?: string;
|
|
2339
|
+
};
|
|
2340
|
+
header?: never;
|
|
2341
|
+
path: {
|
|
2342
|
+
incidentId: string;
|
|
2343
|
+
};
|
|
2344
|
+
cookie?: never;
|
|
2345
|
+
};
|
|
2346
|
+
requestBody?: never;
|
|
2347
|
+
responses: {
|
|
2348
|
+
/** @description OK */
|
|
2349
|
+
200: {
|
|
2350
|
+
headers: {
|
|
2351
|
+
[name: string]: unknown;
|
|
2352
|
+
};
|
|
2353
|
+
content: {
|
|
2354
|
+
"application/json": components["schemas"]["CursorPageIncidentActivityResource"];
|
|
2355
|
+
};
|
|
2356
|
+
};
|
|
2357
|
+
/** @description Error */
|
|
2358
|
+
default: {
|
|
2359
|
+
headers: {
|
|
2360
|
+
[name: string]: unknown;
|
|
2361
|
+
};
|
|
2362
|
+
content: {
|
|
2363
|
+
"application/json": components["schemas"]["Error"];
|
|
2364
|
+
};
|
|
2365
|
+
};
|
|
2366
|
+
};
|
|
2367
|
+
};
|
|
2368
|
+
"list-maintenance-windows": {
|
|
2369
|
+
parameters: {
|
|
2370
|
+
query?: never;
|
|
2371
|
+
header?: never;
|
|
2372
|
+
path?: never;
|
|
2373
|
+
cookie?: never;
|
|
2374
|
+
};
|
|
2375
|
+
requestBody?: never;
|
|
2376
|
+
responses: {
|
|
2377
|
+
/** @description OK */
|
|
2378
|
+
200: {
|
|
2379
|
+
headers: {
|
|
2380
|
+
[name: string]: unknown;
|
|
2381
|
+
};
|
|
2382
|
+
content: {
|
|
2383
|
+
"application/json": components["schemas"]["MaintenanceWindowListResponseBody"];
|
|
2384
|
+
};
|
|
2385
|
+
};
|
|
2386
|
+
/** @description Error */
|
|
2387
|
+
default: {
|
|
2388
|
+
headers: {
|
|
2389
|
+
[name: string]: unknown;
|
|
2390
|
+
};
|
|
2391
|
+
content: {
|
|
2392
|
+
"application/json": components["schemas"]["Error"];
|
|
2393
|
+
};
|
|
2394
|
+
};
|
|
2395
|
+
};
|
|
2396
|
+
};
|
|
2397
|
+
"get-maintenance-window": {
|
|
2398
|
+
parameters: {
|
|
2399
|
+
query?: never;
|
|
2400
|
+
header?: never;
|
|
2401
|
+
path: {
|
|
2402
|
+
windowId: string;
|
|
2403
|
+
};
|
|
2404
|
+
cookie?: never;
|
|
2405
|
+
};
|
|
2406
|
+
requestBody?: never;
|
|
2407
|
+
responses: {
|
|
2408
|
+
/** @description OK */
|
|
2409
|
+
200: {
|
|
2410
|
+
headers: {
|
|
2411
|
+
[name: string]: unknown;
|
|
2412
|
+
};
|
|
2413
|
+
content: {
|
|
2414
|
+
"application/json": components["schemas"]["MaintenanceWindowResource"];
|
|
2415
|
+
};
|
|
2416
|
+
};
|
|
2417
|
+
/** @description Error */
|
|
2418
|
+
default: {
|
|
2419
|
+
headers: {
|
|
2420
|
+
[name: string]: unknown;
|
|
2421
|
+
};
|
|
2422
|
+
content: {
|
|
2423
|
+
"application/json": components["schemas"]["Error"];
|
|
2424
|
+
};
|
|
2425
|
+
};
|
|
2426
|
+
};
|
|
2427
|
+
};
|
|
2428
|
+
"put-maintenance-window": {
|
|
2429
|
+
parameters: {
|
|
2430
|
+
query?: never;
|
|
2431
|
+
header?: never;
|
|
2432
|
+
path: {
|
|
2433
|
+
windowId: string;
|
|
2434
|
+
};
|
|
2435
|
+
cookie?: never;
|
|
2436
|
+
};
|
|
2437
|
+
requestBody: {
|
|
2438
|
+
content: {
|
|
2439
|
+
"application/json": components["schemas"]["PutMaintenanceWindowRequestBody"];
|
|
2440
|
+
};
|
|
2441
|
+
};
|
|
2442
|
+
responses: {
|
|
2443
|
+
/** @description OK */
|
|
2444
|
+
200: {
|
|
2445
|
+
headers: {
|
|
2446
|
+
[name: string]: unknown;
|
|
2447
|
+
};
|
|
2448
|
+
content: {
|
|
2449
|
+
"application/json": components["schemas"]["MaintenanceWindowResource"];
|
|
2450
|
+
};
|
|
2451
|
+
};
|
|
2452
|
+
/** @description Error */
|
|
2453
|
+
default: {
|
|
2454
|
+
headers: {
|
|
2455
|
+
[name: string]: unknown;
|
|
2456
|
+
};
|
|
2457
|
+
content: {
|
|
2458
|
+
"application/json": components["schemas"]["Error"];
|
|
2459
|
+
};
|
|
2460
|
+
};
|
|
2461
|
+
};
|
|
2462
|
+
};
|
|
2463
|
+
"delete-maintenance-window": {
|
|
2464
|
+
parameters: {
|
|
2465
|
+
query?: never;
|
|
2466
|
+
header?: never;
|
|
2467
|
+
path: {
|
|
2468
|
+
windowId: string;
|
|
2469
|
+
};
|
|
2470
|
+
cookie?: never;
|
|
2471
|
+
};
|
|
2472
|
+
requestBody?: never;
|
|
2473
|
+
responses: {
|
|
2474
|
+
/** @description No Content */
|
|
2475
|
+
204: {
|
|
2476
|
+
headers: {
|
|
2477
|
+
[name: string]: unknown;
|
|
2478
|
+
};
|
|
2479
|
+
content?: never;
|
|
2480
|
+
};
|
|
2481
|
+
/** @description Error */
|
|
2482
|
+
default: {
|
|
2483
|
+
headers: {
|
|
2484
|
+
[name: string]: unknown;
|
|
2485
|
+
};
|
|
2486
|
+
content: {
|
|
2487
|
+
"application/json": components["schemas"]["Error"];
|
|
2488
|
+
};
|
|
2489
|
+
};
|
|
2490
|
+
};
|
|
2491
|
+
};
|
|
2492
|
+
"get-project-overview": {
|
|
2493
|
+
parameters: {
|
|
2494
|
+
query?: never;
|
|
2495
|
+
header?: never;
|
|
2496
|
+
path?: never;
|
|
2497
|
+
cookie?: never;
|
|
2498
|
+
};
|
|
2499
|
+
requestBody?: never;
|
|
2500
|
+
responses: {
|
|
2501
|
+
/** @description OK */
|
|
2502
|
+
200: {
|
|
2503
|
+
headers: {
|
|
2504
|
+
[name: string]: unknown;
|
|
2505
|
+
};
|
|
2506
|
+
content: {
|
|
2507
|
+
"application/json": components["schemas"]["ProjectOverviewResource"];
|
|
2508
|
+
};
|
|
2509
|
+
};
|
|
2510
|
+
/** @description Error */
|
|
2511
|
+
default: {
|
|
2512
|
+
headers: {
|
|
2513
|
+
[name: string]: unknown;
|
|
2514
|
+
};
|
|
2515
|
+
content: {
|
|
2516
|
+
"application/json": components["schemas"]["Error"];
|
|
2517
|
+
};
|
|
2518
|
+
};
|
|
2519
|
+
};
|
|
2520
|
+
};
|
|
2521
|
+
"list-server-items": {
|
|
2522
|
+
parameters: {
|
|
2523
|
+
query?: {
|
|
2524
|
+
/** @description Fuzzy match on key or name */
|
|
2525
|
+
keyword?: string;
|
|
2526
|
+
/** @description Given as `key` or `key=value`, repeatable. The `component` tags applied by the official templates (cpu, memory, filesystem and so on) are filtered through this */
|
|
2527
|
+
tag?: string[] | null;
|
|
2528
|
+
};
|
|
2529
|
+
header?: never;
|
|
2530
|
+
path: {
|
|
2531
|
+
serverId: string;
|
|
2532
|
+
};
|
|
2533
|
+
cookie?: never;
|
|
2534
|
+
};
|
|
2535
|
+
requestBody?: never;
|
|
2536
|
+
responses: {
|
|
2537
|
+
/** @description OK */
|
|
2538
|
+
200: {
|
|
2539
|
+
headers: {
|
|
2540
|
+
[name: string]: unknown;
|
|
2541
|
+
};
|
|
2542
|
+
content: {
|
|
2543
|
+
"application/json": components["schemas"]["ItemListResponseBody"];
|
|
2544
|
+
};
|
|
2545
|
+
};
|
|
2546
|
+
/** @description Error */
|
|
2547
|
+
default: {
|
|
2548
|
+
headers: {
|
|
2549
|
+
[name: string]: unknown;
|
|
2550
|
+
};
|
|
2551
|
+
content: {
|
|
2552
|
+
"application/json": components["schemas"]["Error"];
|
|
2553
|
+
};
|
|
2554
|
+
};
|
|
2555
|
+
};
|
|
2556
|
+
};
|
|
2557
|
+
"get-server-metric": {
|
|
2558
|
+
parameters: {
|
|
2559
|
+
query?: {
|
|
2560
|
+
/** @description **Prefix match**: `vfs.fs.size` returns one series per mount point. Supply this or `item_id` */
|
|
2561
|
+
item_key?: string;
|
|
2562
|
+
item_id?: string;
|
|
2563
|
+
/** @description Defaults to one hour ago */
|
|
2564
|
+
from?: string;
|
|
2565
|
+
to?: string;
|
|
2566
|
+
/** @description Number of downsampling buckets. 0 returns the collected data points unchanged */
|
|
2567
|
+
max_points?: number;
|
|
2568
|
+
/** @description Also return the thresholds currently in effect for these items */
|
|
2569
|
+
include_thresholds?: boolean;
|
|
2570
|
+
};
|
|
2571
|
+
header?: never;
|
|
2572
|
+
path: {
|
|
2573
|
+
serverId: string;
|
|
2574
|
+
};
|
|
2575
|
+
cookie?: never;
|
|
2576
|
+
};
|
|
2577
|
+
requestBody?: never;
|
|
2578
|
+
responses: {
|
|
2579
|
+
/** @description OK */
|
|
2580
|
+
200: {
|
|
2581
|
+
headers: {
|
|
2582
|
+
[name: string]: unknown;
|
|
2583
|
+
};
|
|
2584
|
+
content: {
|
|
2585
|
+
"application/json": components["schemas"]["MetricResponseBody"];
|
|
2586
|
+
};
|
|
2587
|
+
};
|
|
2588
|
+
/** @description Error */
|
|
2589
|
+
default: {
|
|
2590
|
+
headers: {
|
|
2591
|
+
[name: string]: unknown;
|
|
2592
|
+
};
|
|
2593
|
+
content: {
|
|
2594
|
+
"application/json": components["schemas"]["Error"];
|
|
2595
|
+
};
|
|
2596
|
+
};
|
|
2597
|
+
};
|
|
2598
|
+
};
|
|
2599
|
+
"get-server-resources": {
|
|
2600
|
+
parameters: {
|
|
2601
|
+
query?: never;
|
|
2602
|
+
header?: never;
|
|
2603
|
+
path: {
|
|
2604
|
+
serverId: string;
|
|
2605
|
+
};
|
|
2606
|
+
cookie?: never;
|
|
2607
|
+
};
|
|
2608
|
+
requestBody?: never;
|
|
2609
|
+
responses: {
|
|
2610
|
+
/** @description OK */
|
|
2611
|
+
200: {
|
|
2612
|
+
headers: {
|
|
2613
|
+
[name: string]: unknown;
|
|
2614
|
+
};
|
|
2615
|
+
content: {
|
|
2616
|
+
"application/json": components["schemas"]["ServerResourcesResource"];
|
|
2617
|
+
};
|
|
2618
|
+
};
|
|
2619
|
+
/** @description Error */
|
|
2620
|
+
default: {
|
|
2621
|
+
headers: {
|
|
2622
|
+
[name: string]: unknown;
|
|
2623
|
+
};
|
|
2624
|
+
content: {
|
|
2625
|
+
"application/json": components["schemas"]["Error"];
|
|
2626
|
+
};
|
|
2627
|
+
};
|
|
2628
|
+
};
|
|
2629
|
+
};
|
|
2630
|
+
"get-server-snapshot": {
|
|
2631
|
+
parameters: {
|
|
2632
|
+
query?: never;
|
|
2633
|
+
header?: never;
|
|
2634
|
+
path: {
|
|
2635
|
+
serverId: string;
|
|
2636
|
+
};
|
|
2637
|
+
cookie?: never;
|
|
2638
|
+
};
|
|
2639
|
+
requestBody?: never;
|
|
2640
|
+
responses: {
|
|
2641
|
+
/** @description OK */
|
|
2642
|
+
200: {
|
|
2643
|
+
headers: {
|
|
2644
|
+
[name: string]: unknown;
|
|
2645
|
+
};
|
|
2646
|
+
content: {
|
|
2647
|
+
"application/json": components["schemas"]["SnapshotResource"];
|
|
2648
|
+
};
|
|
2649
|
+
};
|
|
2650
|
+
/** @description Error */
|
|
2651
|
+
default: {
|
|
2652
|
+
headers: {
|
|
2653
|
+
[name: string]: unknown;
|
|
2654
|
+
};
|
|
2655
|
+
content: {
|
|
2656
|
+
"application/json": components["schemas"]["Error"];
|
|
2657
|
+
};
|
|
2658
|
+
};
|
|
2659
|
+
};
|
|
2660
|
+
};
|
|
2661
|
+
"list-project-top-items": {
|
|
2662
|
+
parameters: {
|
|
2663
|
+
query: {
|
|
2664
|
+
kind: "CPU_UTILIZATION" | "MEMORY_UTILIZATION" | "ROOT_FILESYSTEM_USED";
|
|
2665
|
+
/** @description 0 uses the default */
|
|
2666
|
+
limit?: number;
|
|
2667
|
+
};
|
|
2668
|
+
header?: never;
|
|
2669
|
+
path?: never;
|
|
2670
|
+
cookie?: never;
|
|
2671
|
+
};
|
|
2672
|
+
requestBody?: never;
|
|
2673
|
+
responses: {
|
|
2674
|
+
/** @description OK */
|
|
2675
|
+
200: {
|
|
2676
|
+
headers: {
|
|
2677
|
+
[name: string]: unknown;
|
|
2678
|
+
};
|
|
2679
|
+
content: {
|
|
2680
|
+
"application/json": components["schemas"]["TopItemListResponseBody"];
|
|
2681
|
+
};
|
|
2682
|
+
};
|
|
2683
|
+
/** @description Error */
|
|
2684
|
+
default: {
|
|
2685
|
+
headers: {
|
|
2686
|
+
[name: string]: unknown;
|
|
2687
|
+
};
|
|
2688
|
+
content: {
|
|
2689
|
+
"application/json": components["schemas"]["Error"];
|
|
2690
|
+
};
|
|
2691
|
+
};
|
|
2692
|
+
};
|
|
2693
|
+
};
|
|
2694
|
+
"list-templates": {
|
|
2695
|
+
parameters: {
|
|
2696
|
+
query?: never;
|
|
2697
|
+
header?: never;
|
|
2698
|
+
path?: never;
|
|
2699
|
+
cookie?: never;
|
|
2700
|
+
};
|
|
2701
|
+
requestBody?: never;
|
|
2702
|
+
responses: {
|
|
2703
|
+
/** @description OK */
|
|
2704
|
+
200: {
|
|
2705
|
+
headers: {
|
|
2706
|
+
[name: string]: unknown;
|
|
2707
|
+
};
|
|
2708
|
+
content: {
|
|
2709
|
+
"application/json": components["schemas"]["TemplateCatalogResponseBody"];
|
|
2710
|
+
};
|
|
2711
|
+
};
|
|
2712
|
+
/** @description Error */
|
|
2713
|
+
default: {
|
|
2714
|
+
headers: {
|
|
2715
|
+
[name: string]: unknown;
|
|
2716
|
+
};
|
|
2717
|
+
content: {
|
|
2718
|
+
"application/json": components["schemas"]["Error"];
|
|
2719
|
+
};
|
|
2720
|
+
};
|
|
2721
|
+
};
|
|
2722
|
+
};
|
|
2723
|
+
"list-servers": {
|
|
2724
|
+
parameters: {
|
|
2725
|
+
query?: {
|
|
2726
|
+
/** @description Maximum number of records in this page */
|
|
2727
|
+
limit?: number;
|
|
2728
|
+
/** @description Number of records to skip. For deeper paging, use the cursor-paged endpoint instead */
|
|
2729
|
+
offset?: number;
|
|
2730
|
+
/** @description Fuzzy match on name or address */
|
|
2731
|
+
keyword?: string;
|
|
2732
|
+
monitoring_status?: "PENDING" | "ACTIVE" | "DISABLED" | "FAILED";
|
|
2733
|
+
};
|
|
2734
|
+
header?: never;
|
|
2735
|
+
path?: never;
|
|
2736
|
+
cookie?: never;
|
|
2737
|
+
};
|
|
2738
|
+
requestBody?: never;
|
|
2739
|
+
responses: {
|
|
2740
|
+
/** @description OK */
|
|
2741
|
+
200: {
|
|
2742
|
+
headers: {
|
|
2743
|
+
[name: string]: unknown;
|
|
2744
|
+
};
|
|
2745
|
+
content: {
|
|
2746
|
+
"application/json": components["schemas"]["LengthAwarePageServerResource"];
|
|
2747
|
+
};
|
|
2748
|
+
};
|
|
2749
|
+
/** @description Error */
|
|
2750
|
+
default: {
|
|
2751
|
+
headers: {
|
|
2752
|
+
[name: string]: unknown;
|
|
2753
|
+
};
|
|
2754
|
+
content: {
|
|
2755
|
+
"application/json": components["schemas"]["Error"];
|
|
2756
|
+
};
|
|
2757
|
+
};
|
|
2758
|
+
};
|
|
2759
|
+
};
|
|
2760
|
+
"get-server": {
|
|
2761
|
+
parameters: {
|
|
2762
|
+
query?: never;
|
|
2763
|
+
header?: never;
|
|
2764
|
+
path: {
|
|
2765
|
+
serverId: string;
|
|
2766
|
+
};
|
|
2767
|
+
cookie?: never;
|
|
2768
|
+
};
|
|
2769
|
+
requestBody?: never;
|
|
2770
|
+
responses: {
|
|
2771
|
+
/** @description OK */
|
|
2772
|
+
200: {
|
|
2773
|
+
headers: {
|
|
2774
|
+
[name: string]: unknown;
|
|
2775
|
+
};
|
|
2776
|
+
content: {
|
|
2777
|
+
"application/json": components["schemas"]["ServerResource"];
|
|
2778
|
+
};
|
|
2779
|
+
};
|
|
2780
|
+
/** @description Error */
|
|
2781
|
+
default: {
|
|
2782
|
+
headers: {
|
|
2783
|
+
[name: string]: unknown;
|
|
2784
|
+
};
|
|
2785
|
+
content: {
|
|
2786
|
+
"application/json": components["schemas"]["Error"];
|
|
2787
|
+
};
|
|
2788
|
+
};
|
|
2789
|
+
};
|
|
2790
|
+
};
|
|
2791
|
+
"enable-server-monitoring": {
|
|
2792
|
+
parameters: {
|
|
2793
|
+
query?: never;
|
|
2794
|
+
header?: never;
|
|
2795
|
+
path: {
|
|
2796
|
+
/** @description Supplied by the caller; no operation issues one. Reuse the identifier the machine already carries in the originating system — a Leaflow Compute instance id, or the caller's own inventory identifier — or allocate a UUID and persist it before the first call. It is the idempotency key of the enrollment. */
|
|
2797
|
+
serverId: string;
|
|
2798
|
+
};
|
|
2799
|
+
cookie?: never;
|
|
2800
|
+
};
|
|
2801
|
+
requestBody: {
|
|
2802
|
+
content: {
|
|
2803
|
+
"application/json": components["schemas"]["EnableMonitoringRequestBody"];
|
|
2804
|
+
};
|
|
2805
|
+
};
|
|
2806
|
+
responses: {
|
|
2807
|
+
/** @description OK */
|
|
2808
|
+
200: {
|
|
2809
|
+
headers: {
|
|
2810
|
+
[name: string]: unknown;
|
|
2811
|
+
};
|
|
2812
|
+
content: {
|
|
2813
|
+
"application/json": components["schemas"]["ServerEnrollmentResponseBody"];
|
|
2814
|
+
};
|
|
2815
|
+
};
|
|
2816
|
+
/** @description Error */
|
|
2817
|
+
default: {
|
|
2818
|
+
headers: {
|
|
2819
|
+
[name: string]: unknown;
|
|
2820
|
+
};
|
|
2821
|
+
content: {
|
|
2822
|
+
"application/json": components["schemas"]["Error"];
|
|
2823
|
+
};
|
|
2824
|
+
};
|
|
2825
|
+
};
|
|
2826
|
+
};
|
|
2827
|
+
"delete-server": {
|
|
2828
|
+
parameters: {
|
|
2829
|
+
query?: never;
|
|
2830
|
+
header?: never;
|
|
2831
|
+
path: {
|
|
2832
|
+
serverId: string;
|
|
2833
|
+
};
|
|
2834
|
+
cookie?: never;
|
|
2835
|
+
};
|
|
2836
|
+
requestBody?: never;
|
|
2837
|
+
responses: {
|
|
2838
|
+
/** @description No Content */
|
|
2839
|
+
204: {
|
|
2840
|
+
headers: {
|
|
2841
|
+
[name: string]: unknown;
|
|
2842
|
+
};
|
|
2843
|
+
content?: never;
|
|
2844
|
+
};
|
|
2845
|
+
/** @description Error */
|
|
2846
|
+
default: {
|
|
2847
|
+
headers: {
|
|
2848
|
+
[name: string]: unknown;
|
|
2849
|
+
};
|
|
2850
|
+
content: {
|
|
2851
|
+
"application/json": components["schemas"]["Error"];
|
|
2852
|
+
};
|
|
2853
|
+
};
|
|
2854
|
+
};
|
|
2855
|
+
};
|
|
2856
|
+
"update-server": {
|
|
2857
|
+
parameters: {
|
|
2858
|
+
query?: never;
|
|
2859
|
+
header?: never;
|
|
2860
|
+
path: {
|
|
2861
|
+
serverId: string;
|
|
2862
|
+
};
|
|
2863
|
+
cookie?: never;
|
|
2864
|
+
};
|
|
2865
|
+
requestBody: {
|
|
2866
|
+
content: {
|
|
2867
|
+
"application/json": components["schemas"]["UpdateServerRequestBody"];
|
|
2868
|
+
};
|
|
2869
|
+
};
|
|
2870
|
+
responses: {
|
|
2871
|
+
/** @description OK */
|
|
2872
|
+
200: {
|
|
2873
|
+
headers: {
|
|
2874
|
+
[name: string]: unknown;
|
|
2875
|
+
};
|
|
2876
|
+
content: {
|
|
2877
|
+
"application/json": components["schemas"]["ServerResource"];
|
|
2878
|
+
};
|
|
2879
|
+
};
|
|
2880
|
+
/** @description Error */
|
|
2881
|
+
default: {
|
|
2882
|
+
headers: {
|
|
2883
|
+
[name: string]: unknown;
|
|
2884
|
+
};
|
|
2885
|
+
content: {
|
|
2886
|
+
"application/json": components["schemas"]["Error"];
|
|
2887
|
+
};
|
|
2888
|
+
};
|
|
2889
|
+
};
|
|
2890
|
+
};
|
|
2891
|
+
"disable-server-monitoring": {
|
|
2892
|
+
parameters: {
|
|
2893
|
+
query?: never;
|
|
2894
|
+
header?: never;
|
|
2895
|
+
path: {
|
|
2896
|
+
serverId: string;
|
|
2897
|
+
};
|
|
2898
|
+
cookie?: never;
|
|
2899
|
+
};
|
|
2900
|
+
requestBody?: never;
|
|
2901
|
+
responses: {
|
|
2902
|
+
/** @description No Content */
|
|
2903
|
+
204: {
|
|
2904
|
+
headers: {
|
|
2905
|
+
[name: string]: unknown;
|
|
2906
|
+
};
|
|
2907
|
+
content?: never;
|
|
2908
|
+
};
|
|
2909
|
+
/** @description Error */
|
|
2910
|
+
default: {
|
|
2911
|
+
headers: {
|
|
2912
|
+
[name: string]: unknown;
|
|
2913
|
+
};
|
|
2914
|
+
content: {
|
|
2915
|
+
"application/json": components["schemas"]["Error"];
|
|
2916
|
+
};
|
|
2917
|
+
};
|
|
2918
|
+
};
|
|
2919
|
+
};
|
|
2920
|
+
"rotate-agent-psk": {
|
|
2921
|
+
parameters: {
|
|
2922
|
+
query?: never;
|
|
2923
|
+
header?: never;
|
|
2924
|
+
path: {
|
|
2925
|
+
serverId: string;
|
|
2926
|
+
};
|
|
2927
|
+
cookie?: never;
|
|
2928
|
+
};
|
|
2929
|
+
requestBody?: never;
|
|
2930
|
+
responses: {
|
|
2931
|
+
/** @description OK */
|
|
2932
|
+
200: {
|
|
2933
|
+
headers: {
|
|
2934
|
+
[name: string]: unknown;
|
|
2935
|
+
};
|
|
2936
|
+
content: {
|
|
2937
|
+
"application/json": components["schemas"]["EnrollmentResource"];
|
|
1200
2938
|
};
|
|
1201
2939
|
};
|
|
1202
2940
|
/** @description Error */
|
|
@@ -1210,12 +2948,13 @@ export interface operations {
|
|
|
1210
2948
|
};
|
|
1211
2949
|
};
|
|
1212
2950
|
};
|
|
1213
|
-
"get-
|
|
2951
|
+
"get-web-check": {
|
|
1214
2952
|
parameters: {
|
|
1215
2953
|
query?: never;
|
|
1216
2954
|
header?: never;
|
|
1217
2955
|
path: {
|
|
1218
|
-
|
|
2956
|
+
serverId: string;
|
|
2957
|
+
checkId: string;
|
|
1219
2958
|
};
|
|
1220
2959
|
cookie?: never;
|
|
1221
2960
|
};
|
|
@@ -1227,7 +2966,7 @@ export interface operations {
|
|
|
1227
2966
|
[name: string]: unknown;
|
|
1228
2967
|
};
|
|
1229
2968
|
content: {
|
|
1230
|
-
"application/json": components["schemas"]["
|
|
2969
|
+
"application/json": components["schemas"]["WebCheckResource"];
|
|
1231
2970
|
};
|
|
1232
2971
|
};
|
|
1233
2972
|
/** @description Error */
|
|
@@ -1241,18 +2980,19 @@ export interface operations {
|
|
|
1241
2980
|
};
|
|
1242
2981
|
};
|
|
1243
2982
|
};
|
|
1244
|
-
"
|
|
2983
|
+
"put-web-check": {
|
|
1245
2984
|
parameters: {
|
|
1246
2985
|
query?: never;
|
|
1247
2986
|
header?: never;
|
|
1248
2987
|
path: {
|
|
1249
|
-
|
|
2988
|
+
serverId: string;
|
|
2989
|
+
checkId: string;
|
|
1250
2990
|
};
|
|
1251
2991
|
cookie?: never;
|
|
1252
2992
|
};
|
|
1253
2993
|
requestBody: {
|
|
1254
2994
|
content: {
|
|
1255
|
-
"application/json": components["schemas"]["
|
|
2995
|
+
"application/json": components["schemas"]["PutWebCheckRequestBody"];
|
|
1256
2996
|
};
|
|
1257
2997
|
};
|
|
1258
2998
|
responses: {
|
|
@@ -1262,7 +3002,7 @@ export interface operations {
|
|
|
1262
3002
|
[name: string]: unknown;
|
|
1263
3003
|
};
|
|
1264
3004
|
content: {
|
|
1265
|
-
"application/json": components["schemas"]["
|
|
3005
|
+
"application/json": components["schemas"]["WebCheckResource"];
|
|
1266
3006
|
};
|
|
1267
3007
|
};
|
|
1268
3008
|
/** @description Error */
|
|
@@ -1276,20 +3016,47 @@ export interface operations {
|
|
|
1276
3016
|
};
|
|
1277
3017
|
};
|
|
1278
3018
|
};
|
|
1279
|
-
"
|
|
3019
|
+
"delete-web-check": {
|
|
1280
3020
|
parameters: {
|
|
1281
3021
|
query?: never;
|
|
1282
3022
|
header?: never;
|
|
1283
3023
|
path: {
|
|
1284
|
-
|
|
3024
|
+
serverId: string;
|
|
3025
|
+
checkId: string;
|
|
1285
3026
|
};
|
|
1286
3027
|
cookie?: never;
|
|
1287
3028
|
};
|
|
1288
|
-
requestBody
|
|
1289
|
-
|
|
1290
|
-
|
|
3029
|
+
requestBody?: never;
|
|
3030
|
+
responses: {
|
|
3031
|
+
/** @description No Content */
|
|
3032
|
+
204: {
|
|
3033
|
+
headers: {
|
|
3034
|
+
[name: string]: unknown;
|
|
3035
|
+
};
|
|
3036
|
+
content?: never;
|
|
3037
|
+
};
|
|
3038
|
+
/** @description Error */
|
|
3039
|
+
default: {
|
|
3040
|
+
headers: {
|
|
3041
|
+
[name: string]: unknown;
|
|
3042
|
+
};
|
|
3043
|
+
content: {
|
|
3044
|
+
"application/json": components["schemas"]["Error"];
|
|
3045
|
+
};
|
|
3046
|
+
};
|
|
3047
|
+
};
|
|
3048
|
+
};
|
|
3049
|
+
"list-web-checks": {
|
|
3050
|
+
parameters: {
|
|
3051
|
+
query?: {
|
|
3052
|
+
/** @description Restrict to the checks of a single machine. Omit for the whole project */
|
|
3053
|
+
server_id?: string;
|
|
1291
3054
|
};
|
|
3055
|
+
header?: never;
|
|
3056
|
+
path?: never;
|
|
3057
|
+
cookie?: never;
|
|
1292
3058
|
};
|
|
3059
|
+
requestBody?: never;
|
|
1293
3060
|
responses: {
|
|
1294
3061
|
/** @description OK */
|
|
1295
3062
|
200: {
|
|
@@ -1297,7 +3064,7 @@ export interface operations {
|
|
|
1297
3064
|
[name: string]: unknown;
|
|
1298
3065
|
};
|
|
1299
3066
|
content: {
|
|
1300
|
-
"application/json": components["schemas"]["
|
|
3067
|
+
"application/json": components["schemas"]["WebCheckListResponseBody"];
|
|
1301
3068
|
};
|
|
1302
3069
|
};
|
|
1303
3070
|
/** @description Error */
|
|
@@ -1311,18 +3078,79 @@ export interface operations {
|
|
|
1311
3078
|
};
|
|
1312
3079
|
};
|
|
1313
3080
|
};
|
|
1314
|
-
"
|
|
3081
|
+
"get-sli-report": {
|
|
3082
|
+
parameters: {
|
|
3083
|
+
query?: {
|
|
3084
|
+
from?: string;
|
|
3085
|
+
to?: string;
|
|
3086
|
+
/** @description Return the most recent N complete periods. Use this or from/to, not both */
|
|
3087
|
+
periods?: number;
|
|
3088
|
+
};
|
|
3089
|
+
header?: never;
|
|
3090
|
+
path?: never;
|
|
3091
|
+
cookie?: never;
|
|
3092
|
+
};
|
|
3093
|
+
requestBody?: never;
|
|
3094
|
+
responses: {
|
|
3095
|
+
/** @description OK */
|
|
3096
|
+
200: {
|
|
3097
|
+
headers: {
|
|
3098
|
+
[name: string]: unknown;
|
|
3099
|
+
};
|
|
3100
|
+
content: {
|
|
3101
|
+
"application/json": components["schemas"]["SLIReportResponseBody"];
|
|
3102
|
+
};
|
|
3103
|
+
};
|
|
3104
|
+
/** @description Error */
|
|
3105
|
+
default: {
|
|
3106
|
+
headers: {
|
|
3107
|
+
[name: string]: unknown;
|
|
3108
|
+
};
|
|
3109
|
+
content: {
|
|
3110
|
+
"application/json": components["schemas"]["Error"];
|
|
3111
|
+
};
|
|
3112
|
+
};
|
|
3113
|
+
};
|
|
3114
|
+
};
|
|
3115
|
+
"get-slo": {
|
|
1315
3116
|
parameters: {
|
|
1316
3117
|
query?: never;
|
|
1317
3118
|
header?: never;
|
|
1318
|
-
path
|
|
1319
|
-
|
|
3119
|
+
path?: never;
|
|
3120
|
+
cookie?: never;
|
|
3121
|
+
};
|
|
3122
|
+
requestBody?: never;
|
|
3123
|
+
responses: {
|
|
3124
|
+
/** @description OK */
|
|
3125
|
+
200: {
|
|
3126
|
+
headers: {
|
|
3127
|
+
[name: string]: unknown;
|
|
3128
|
+
};
|
|
3129
|
+
content: {
|
|
3130
|
+
"application/json": components["schemas"]["SLOResource"];
|
|
3131
|
+
};
|
|
3132
|
+
};
|
|
3133
|
+
/** @description Error */
|
|
3134
|
+
default: {
|
|
3135
|
+
headers: {
|
|
3136
|
+
[name: string]: unknown;
|
|
3137
|
+
};
|
|
3138
|
+
content: {
|
|
3139
|
+
"application/json": components["schemas"]["Error"];
|
|
3140
|
+
};
|
|
1320
3141
|
};
|
|
3142
|
+
};
|
|
3143
|
+
};
|
|
3144
|
+
"put-slo": {
|
|
3145
|
+
parameters: {
|
|
3146
|
+
query?: never;
|
|
3147
|
+
header?: never;
|
|
3148
|
+
path?: never;
|
|
1321
3149
|
cookie?: never;
|
|
1322
3150
|
};
|
|
1323
3151
|
requestBody: {
|
|
1324
3152
|
content: {
|
|
1325
|
-
"application/json": components["schemas"]["
|
|
3153
|
+
"application/json": components["schemas"]["PutSLORequestBody"];
|
|
1326
3154
|
};
|
|
1327
3155
|
};
|
|
1328
3156
|
responses: {
|
|
@@ -1332,7 +3160,7 @@ export interface operations {
|
|
|
1332
3160
|
[name: string]: unknown;
|
|
1333
3161
|
};
|
|
1334
3162
|
content: {
|
|
1335
|
-
"application/json": components["schemas"]["
|
|
3163
|
+
"application/json": components["schemas"]["SLOResource"];
|
|
1336
3164
|
};
|
|
1337
3165
|
};
|
|
1338
3166
|
/** @description Error */
|
|
@@ -1346,20 +3174,41 @@ export interface operations {
|
|
|
1346
3174
|
};
|
|
1347
3175
|
};
|
|
1348
3176
|
};
|
|
1349
|
-
"
|
|
3177
|
+
"delete-slo": {
|
|
1350
3178
|
parameters: {
|
|
1351
3179
|
query?: never;
|
|
1352
3180
|
header?: never;
|
|
1353
|
-
path
|
|
1354
|
-
incidentId: string;
|
|
1355
|
-
};
|
|
3181
|
+
path?: never;
|
|
1356
3182
|
cookie?: never;
|
|
1357
3183
|
};
|
|
1358
|
-
requestBody
|
|
1359
|
-
|
|
1360
|
-
|
|
3184
|
+
requestBody?: never;
|
|
3185
|
+
responses: {
|
|
3186
|
+
/** @description No Content */
|
|
3187
|
+
204: {
|
|
3188
|
+
headers: {
|
|
3189
|
+
[name: string]: unknown;
|
|
3190
|
+
};
|
|
3191
|
+
content?: never;
|
|
1361
3192
|
};
|
|
3193
|
+
/** @description Error */
|
|
3194
|
+
default: {
|
|
3195
|
+
headers: {
|
|
3196
|
+
[name: string]: unknown;
|
|
3197
|
+
};
|
|
3198
|
+
content: {
|
|
3199
|
+
"application/json": components["schemas"]["Error"];
|
|
3200
|
+
};
|
|
3201
|
+
};
|
|
3202
|
+
};
|
|
3203
|
+
};
|
|
3204
|
+
"get-status-page": {
|
|
3205
|
+
parameters: {
|
|
3206
|
+
query?: never;
|
|
3207
|
+
header?: never;
|
|
3208
|
+
path?: never;
|
|
3209
|
+
cookie?: never;
|
|
1362
3210
|
};
|
|
3211
|
+
requestBody?: never;
|
|
1363
3212
|
responses: {
|
|
1364
3213
|
/** @description OK */
|
|
1365
3214
|
200: {
|
|
@@ -1367,7 +3216,7 @@ export interface operations {
|
|
|
1367
3216
|
[name: string]: unknown;
|
|
1368
3217
|
};
|
|
1369
3218
|
content: {
|
|
1370
|
-
"application/json": components["schemas"]["
|
|
3219
|
+
"application/json": components["schemas"]["StatusPageResource"];
|
|
1371
3220
|
};
|
|
1372
3221
|
};
|
|
1373
3222
|
/** @description Error */
|
|
@@ -1381,18 +3230,16 @@ export interface operations {
|
|
|
1381
3230
|
};
|
|
1382
3231
|
};
|
|
1383
3232
|
};
|
|
1384
|
-
"
|
|
3233
|
+
"put-status-page": {
|
|
1385
3234
|
parameters: {
|
|
1386
3235
|
query?: never;
|
|
1387
3236
|
header?: never;
|
|
1388
|
-
path
|
|
1389
|
-
incidentId: string;
|
|
1390
|
-
};
|
|
3237
|
+
path?: never;
|
|
1391
3238
|
cookie?: never;
|
|
1392
3239
|
};
|
|
1393
3240
|
requestBody: {
|
|
1394
3241
|
content: {
|
|
1395
|
-
"application/json": components["schemas"]["
|
|
3242
|
+
"application/json": components["schemas"]["PutStatusPageRequestBody"];
|
|
1396
3243
|
};
|
|
1397
3244
|
};
|
|
1398
3245
|
responses: {
|
|
@@ -1402,7 +3249,7 @@ export interface operations {
|
|
|
1402
3249
|
[name: string]: unknown;
|
|
1403
3250
|
};
|
|
1404
3251
|
content: {
|
|
1405
|
-
"application/json": components["schemas"]["
|
|
3252
|
+
"application/json": components["schemas"]["StatusPageResource"];
|
|
1406
3253
|
};
|
|
1407
3254
|
};
|
|
1408
3255
|
/** @description Error */
|
|
@@ -1416,13 +3263,69 @@ export interface operations {
|
|
|
1416
3263
|
};
|
|
1417
3264
|
};
|
|
1418
3265
|
};
|
|
1419
|
-
"
|
|
3266
|
+
"delete-status-page": {
|
|
1420
3267
|
parameters: {
|
|
1421
3268
|
query?: never;
|
|
1422
3269
|
header?: never;
|
|
1423
|
-
path
|
|
1424
|
-
|
|
3270
|
+
path?: never;
|
|
3271
|
+
cookie?: never;
|
|
3272
|
+
};
|
|
3273
|
+
requestBody?: never;
|
|
3274
|
+
responses: {
|
|
3275
|
+
/** @description No Content */
|
|
3276
|
+
204: {
|
|
3277
|
+
headers: {
|
|
3278
|
+
[name: string]: unknown;
|
|
3279
|
+
};
|
|
3280
|
+
content?: never;
|
|
3281
|
+
};
|
|
3282
|
+
/** @description Error */
|
|
3283
|
+
default: {
|
|
3284
|
+
headers: {
|
|
3285
|
+
[name: string]: unknown;
|
|
3286
|
+
};
|
|
3287
|
+
content: {
|
|
3288
|
+
"application/json": components["schemas"]["Error"];
|
|
3289
|
+
};
|
|
1425
3290
|
};
|
|
3291
|
+
};
|
|
3292
|
+
};
|
|
3293
|
+
"put-status-page-order": {
|
|
3294
|
+
parameters: {
|
|
3295
|
+
query?: never;
|
|
3296
|
+
header?: never;
|
|
3297
|
+
path?: never;
|
|
3298
|
+
cookie?: never;
|
|
3299
|
+
};
|
|
3300
|
+
requestBody: {
|
|
3301
|
+
content: {
|
|
3302
|
+
"application/json": components["schemas"]["PutStatusPageOrderRequestBody"];
|
|
3303
|
+
};
|
|
3304
|
+
};
|
|
3305
|
+
responses: {
|
|
3306
|
+
/** @description No Content */
|
|
3307
|
+
204: {
|
|
3308
|
+
headers: {
|
|
3309
|
+
[name: string]: unknown;
|
|
3310
|
+
};
|
|
3311
|
+
content?: never;
|
|
3312
|
+
};
|
|
3313
|
+
/** @description Error */
|
|
3314
|
+
default: {
|
|
3315
|
+
headers: {
|
|
3316
|
+
[name: string]: unknown;
|
|
3317
|
+
};
|
|
3318
|
+
content: {
|
|
3319
|
+
"application/json": components["schemas"]["Error"];
|
|
3320
|
+
};
|
|
3321
|
+
};
|
|
3322
|
+
};
|
|
3323
|
+
};
|
|
3324
|
+
"list-status-page-groups": {
|
|
3325
|
+
parameters: {
|
|
3326
|
+
query?: never;
|
|
3327
|
+
header?: never;
|
|
3328
|
+
path?: never;
|
|
1426
3329
|
cookie?: never;
|
|
1427
3330
|
};
|
|
1428
3331
|
requestBody?: never;
|
|
@@ -1433,7 +3336,40 @@ export interface operations {
|
|
|
1433
3336
|
[name: string]: unknown;
|
|
1434
3337
|
};
|
|
1435
3338
|
content: {
|
|
1436
|
-
"application/json": components["schemas"]["
|
|
3339
|
+
"application/json": components["schemas"]["StatusPageGroupListResponseBody"];
|
|
3340
|
+
};
|
|
3341
|
+
};
|
|
3342
|
+
/** @description Error */
|
|
3343
|
+
default: {
|
|
3344
|
+
headers: {
|
|
3345
|
+
[name: string]: unknown;
|
|
3346
|
+
};
|
|
3347
|
+
content: {
|
|
3348
|
+
"application/json": components["schemas"]["Error"];
|
|
3349
|
+
};
|
|
3350
|
+
};
|
|
3351
|
+
};
|
|
3352
|
+
};
|
|
3353
|
+
"create-status-page-group": {
|
|
3354
|
+
parameters: {
|
|
3355
|
+
query?: never;
|
|
3356
|
+
header?: never;
|
|
3357
|
+
path?: never;
|
|
3358
|
+
cookie?: never;
|
|
3359
|
+
};
|
|
3360
|
+
requestBody: {
|
|
3361
|
+
content: {
|
|
3362
|
+
"application/json": components["schemas"]["PutStatusPageGroupRequestBody"];
|
|
3363
|
+
};
|
|
3364
|
+
};
|
|
3365
|
+
responses: {
|
|
3366
|
+
/** @description Created */
|
|
3367
|
+
201: {
|
|
3368
|
+
headers: {
|
|
3369
|
+
[name: string]: unknown;
|
|
3370
|
+
};
|
|
3371
|
+
content: {
|
|
3372
|
+
"application/json": components["schemas"]["StatusPageGroupResource"];
|
|
1437
3373
|
};
|
|
1438
3374
|
};
|
|
1439
3375
|
/** @description Error */
|
|
@@ -1447,20 +3383,20 @@ export interface operations {
|
|
|
1447
3383
|
};
|
|
1448
3384
|
};
|
|
1449
3385
|
};
|
|
1450
|
-
"
|
|
3386
|
+
"update-status-page-group": {
|
|
1451
3387
|
parameters: {
|
|
1452
|
-
query?:
|
|
1453
|
-
limit?: number;
|
|
1454
|
-
/** @description 上一页返回的 next_cursor,空即从头开始 */
|
|
1455
|
-
cursor?: string;
|
|
1456
|
-
};
|
|
3388
|
+
query?: never;
|
|
1457
3389
|
header?: never;
|
|
1458
3390
|
path: {
|
|
1459
|
-
|
|
3391
|
+
groupId: string;
|
|
1460
3392
|
};
|
|
1461
3393
|
cookie?: never;
|
|
1462
3394
|
};
|
|
1463
|
-
requestBody
|
|
3395
|
+
requestBody: {
|
|
3396
|
+
content: {
|
|
3397
|
+
"application/json": components["schemas"]["PutStatusPageGroupRequestBody"];
|
|
3398
|
+
};
|
|
3399
|
+
};
|
|
1464
3400
|
responses: {
|
|
1465
3401
|
/** @description OK */
|
|
1466
3402
|
200: {
|
|
@@ -1468,7 +3404,7 @@ export interface operations {
|
|
|
1468
3404
|
[name: string]: unknown;
|
|
1469
3405
|
};
|
|
1470
3406
|
content: {
|
|
1471
|
-
"application/json": components["schemas"]["
|
|
3407
|
+
"application/json": components["schemas"]["StatusPageGroupResource"];
|
|
1472
3408
|
};
|
|
1473
3409
|
};
|
|
1474
3410
|
/** @description Error */
|
|
@@ -1482,23 +3418,23 @@ export interface operations {
|
|
|
1482
3418
|
};
|
|
1483
3419
|
};
|
|
1484
3420
|
};
|
|
1485
|
-
"
|
|
3421
|
+
"delete-status-page-group": {
|
|
1486
3422
|
parameters: {
|
|
1487
3423
|
query?: never;
|
|
1488
3424
|
header?: never;
|
|
1489
|
-
path
|
|
3425
|
+
path: {
|
|
3426
|
+
groupId: string;
|
|
3427
|
+
};
|
|
1490
3428
|
cookie?: never;
|
|
1491
3429
|
};
|
|
1492
3430
|
requestBody?: never;
|
|
1493
3431
|
responses: {
|
|
1494
|
-
/** @description
|
|
1495
|
-
|
|
3432
|
+
/** @description No Content */
|
|
3433
|
+
204: {
|
|
1496
3434
|
headers: {
|
|
1497
3435
|
[name: string]: unknown;
|
|
1498
3436
|
};
|
|
1499
|
-
content
|
|
1500
|
-
"application/json": components["schemas"]["MaintenanceWindowListResponseBody"];
|
|
1501
|
-
};
|
|
3437
|
+
content?: never;
|
|
1502
3438
|
};
|
|
1503
3439
|
/** @description Error */
|
|
1504
3440
|
default: {
|
|
@@ -1511,25 +3447,27 @@ export interface operations {
|
|
|
1511
3447
|
};
|
|
1512
3448
|
};
|
|
1513
3449
|
};
|
|
1514
|
-
"
|
|
3450
|
+
"put-status-page-group-order": {
|
|
1515
3451
|
parameters: {
|
|
1516
3452
|
query?: never;
|
|
1517
3453
|
header?: never;
|
|
1518
3454
|
path: {
|
|
1519
|
-
|
|
3455
|
+
groupId: string;
|
|
1520
3456
|
};
|
|
1521
3457
|
cookie?: never;
|
|
1522
3458
|
};
|
|
1523
|
-
requestBody
|
|
3459
|
+
requestBody: {
|
|
3460
|
+
content: {
|
|
3461
|
+
"application/json": components["schemas"]["PutStatusPageGroupOrderRequestBody"];
|
|
3462
|
+
};
|
|
3463
|
+
};
|
|
1524
3464
|
responses: {
|
|
1525
|
-
/** @description
|
|
1526
|
-
|
|
3465
|
+
/** @description No Content */
|
|
3466
|
+
204: {
|
|
1527
3467
|
headers: {
|
|
1528
3468
|
[name: string]: unknown;
|
|
1529
3469
|
};
|
|
1530
|
-
content
|
|
1531
|
-
"application/json": components["schemas"]["MaintenanceWindowResource"];
|
|
1532
|
-
};
|
|
3470
|
+
content?: never;
|
|
1533
3471
|
};
|
|
1534
3472
|
/** @description Error */
|
|
1535
3473
|
default: {
|
|
@@ -1542,20 +3480,14 @@ export interface operations {
|
|
|
1542
3480
|
};
|
|
1543
3481
|
};
|
|
1544
3482
|
};
|
|
1545
|
-
"
|
|
3483
|
+
"list-status-page-components": {
|
|
1546
3484
|
parameters: {
|
|
1547
3485
|
query?: never;
|
|
1548
3486
|
header?: never;
|
|
1549
|
-
path
|
|
1550
|
-
windowId: string;
|
|
1551
|
-
};
|
|
3487
|
+
path?: never;
|
|
1552
3488
|
cookie?: never;
|
|
1553
3489
|
};
|
|
1554
|
-
requestBody
|
|
1555
|
-
content: {
|
|
1556
|
-
"application/json": components["schemas"]["PutMaintenanceWindowRequestBody"];
|
|
1557
|
-
};
|
|
1558
|
-
};
|
|
3490
|
+
requestBody?: never;
|
|
1559
3491
|
responses: {
|
|
1560
3492
|
/** @description OK */
|
|
1561
3493
|
200: {
|
|
@@ -1563,7 +3495,7 @@ export interface operations {
|
|
|
1563
3495
|
[name: string]: unknown;
|
|
1564
3496
|
};
|
|
1565
3497
|
content: {
|
|
1566
|
-
"application/json": components["schemas"]["
|
|
3498
|
+
"application/json": components["schemas"]["StatusPageComponentListResponseBody"];
|
|
1567
3499
|
};
|
|
1568
3500
|
};
|
|
1569
3501
|
/** @description Error */
|
|
@@ -1577,23 +3509,27 @@ export interface operations {
|
|
|
1577
3509
|
};
|
|
1578
3510
|
};
|
|
1579
3511
|
};
|
|
1580
|
-
"
|
|
3512
|
+
"create-status-page-component": {
|
|
1581
3513
|
parameters: {
|
|
1582
3514
|
query?: never;
|
|
1583
3515
|
header?: never;
|
|
1584
|
-
path
|
|
1585
|
-
windowId: string;
|
|
1586
|
-
};
|
|
3516
|
+
path?: never;
|
|
1587
3517
|
cookie?: never;
|
|
1588
3518
|
};
|
|
1589
|
-
requestBody
|
|
3519
|
+
requestBody: {
|
|
3520
|
+
content: {
|
|
3521
|
+
"application/json": components["schemas"]["PutStatusPageComponentRequestBody"];
|
|
3522
|
+
};
|
|
3523
|
+
};
|
|
1590
3524
|
responses: {
|
|
1591
|
-
/** @description
|
|
1592
|
-
|
|
3525
|
+
/** @description Created */
|
|
3526
|
+
201: {
|
|
1593
3527
|
headers: {
|
|
1594
3528
|
[name: string]: unknown;
|
|
1595
3529
|
};
|
|
1596
|
-
content
|
|
3530
|
+
content: {
|
|
3531
|
+
"application/json": components["schemas"]["StatusPageComponentResource"];
|
|
3532
|
+
};
|
|
1597
3533
|
};
|
|
1598
3534
|
/** @description Error */
|
|
1599
3535
|
default: {
|
|
@@ -1606,11 +3542,13 @@ export interface operations {
|
|
|
1606
3542
|
};
|
|
1607
3543
|
};
|
|
1608
3544
|
};
|
|
1609
|
-
"get-
|
|
3545
|
+
"get-status-page-component": {
|
|
1610
3546
|
parameters: {
|
|
1611
3547
|
query?: never;
|
|
1612
3548
|
header?: never;
|
|
1613
|
-
path
|
|
3549
|
+
path: {
|
|
3550
|
+
componentId: string;
|
|
3551
|
+
};
|
|
1614
3552
|
cookie?: never;
|
|
1615
3553
|
};
|
|
1616
3554
|
requestBody?: never;
|
|
@@ -1621,7 +3559,7 @@ export interface operations {
|
|
|
1621
3559
|
[name: string]: unknown;
|
|
1622
3560
|
};
|
|
1623
3561
|
content: {
|
|
1624
|
-
"application/json": components["schemas"]["
|
|
3562
|
+
"application/json": components["schemas"]["StatusPageComponentResource"];
|
|
1625
3563
|
};
|
|
1626
3564
|
};
|
|
1627
3565
|
/** @description Error */
|
|
@@ -1635,21 +3573,20 @@ export interface operations {
|
|
|
1635
3573
|
};
|
|
1636
3574
|
};
|
|
1637
3575
|
};
|
|
1638
|
-
"
|
|
3576
|
+
"update-status-page-component": {
|
|
1639
3577
|
parameters: {
|
|
1640
|
-
query?:
|
|
1641
|
-
/** @description 按 key 或名字模糊匹配 */
|
|
1642
|
-
keyword?: string;
|
|
1643
|
-
/** @description 形如 key 或 key=value,可重复。官方模板打好的 component 标签(cpu / memory / filesystem…)就是靠它筛 */
|
|
1644
|
-
tag?: string[] | null;
|
|
1645
|
-
};
|
|
3578
|
+
query?: never;
|
|
1646
3579
|
header?: never;
|
|
1647
3580
|
path: {
|
|
1648
|
-
|
|
3581
|
+
componentId: string;
|
|
1649
3582
|
};
|
|
1650
3583
|
cookie?: never;
|
|
1651
3584
|
};
|
|
1652
|
-
requestBody
|
|
3585
|
+
requestBody: {
|
|
3586
|
+
content: {
|
|
3587
|
+
"application/json": components["schemas"]["PutStatusPageComponentRequestBody"];
|
|
3588
|
+
};
|
|
3589
|
+
};
|
|
1653
3590
|
responses: {
|
|
1654
3591
|
/** @description OK */
|
|
1655
3592
|
200: {
|
|
@@ -1657,7 +3594,7 @@ export interface operations {
|
|
|
1657
3594
|
[name: string]: unknown;
|
|
1658
3595
|
};
|
|
1659
3596
|
content: {
|
|
1660
|
-
"application/json": components["schemas"]["
|
|
3597
|
+
"application/json": components["schemas"]["StatusPageComponentResource"];
|
|
1661
3598
|
};
|
|
1662
3599
|
};
|
|
1663
3600
|
/** @description Error */
|
|
@@ -1671,36 +3608,23 @@ export interface operations {
|
|
|
1671
3608
|
};
|
|
1672
3609
|
};
|
|
1673
3610
|
};
|
|
1674
|
-
"
|
|
3611
|
+
"delete-status-page-component": {
|
|
1675
3612
|
parameters: {
|
|
1676
|
-
query?:
|
|
1677
|
-
/** @description **前缀匹配**:vfs.fs.size 一次拿回每个挂载点一条线。与 item_id 至少给一个 */
|
|
1678
|
-
item_key?: string;
|
|
1679
|
-
item_id?: string;
|
|
1680
|
-
/** @description 不给就是一小时前 */
|
|
1681
|
-
from?: string;
|
|
1682
|
-
to?: string;
|
|
1683
|
-
/** @description 降采样的桶数,0 表示原样返回采集到的数据点 */
|
|
1684
|
-
max_points?: number;
|
|
1685
|
-
/** @description 顺带取这些监控项当前生效的阈值线 */
|
|
1686
|
-
include_thresholds?: boolean;
|
|
1687
|
-
};
|
|
3613
|
+
query?: never;
|
|
1688
3614
|
header?: never;
|
|
1689
3615
|
path: {
|
|
1690
|
-
|
|
3616
|
+
componentId: string;
|
|
1691
3617
|
};
|
|
1692
3618
|
cookie?: never;
|
|
1693
3619
|
};
|
|
1694
3620
|
requestBody?: never;
|
|
1695
3621
|
responses: {
|
|
1696
|
-
/** @description
|
|
1697
|
-
|
|
3622
|
+
/** @description No Content */
|
|
3623
|
+
204: {
|
|
1698
3624
|
headers: {
|
|
1699
3625
|
[name: string]: unknown;
|
|
1700
3626
|
};
|
|
1701
|
-
content
|
|
1702
|
-
"application/json": components["schemas"]["MetricResponseBody"];
|
|
1703
|
-
};
|
|
3627
|
+
content?: never;
|
|
1704
3628
|
};
|
|
1705
3629
|
/** @description Error */
|
|
1706
3630
|
default: {
|
|
@@ -1713,12 +3637,12 @@ export interface operations {
|
|
|
1713
3637
|
};
|
|
1714
3638
|
};
|
|
1715
3639
|
};
|
|
1716
|
-
"
|
|
3640
|
+
"list-status-page-component-sources": {
|
|
1717
3641
|
parameters: {
|
|
1718
3642
|
query?: never;
|
|
1719
3643
|
header?: never;
|
|
1720
3644
|
path: {
|
|
1721
|
-
|
|
3645
|
+
componentId: string;
|
|
1722
3646
|
};
|
|
1723
3647
|
cookie?: never;
|
|
1724
3648
|
};
|
|
@@ -1730,7 +3654,7 @@ export interface operations {
|
|
|
1730
3654
|
[name: string]: unknown;
|
|
1731
3655
|
};
|
|
1732
3656
|
content: {
|
|
1733
|
-
"application/json": components["schemas"]["
|
|
3657
|
+
"application/json": components["schemas"]["StatusPageComponentSourcesResource"];
|
|
1734
3658
|
};
|
|
1735
3659
|
};
|
|
1736
3660
|
/** @description Error */
|
|
@@ -1744,16 +3668,20 @@ export interface operations {
|
|
|
1744
3668
|
};
|
|
1745
3669
|
};
|
|
1746
3670
|
};
|
|
1747
|
-
"
|
|
3671
|
+
"put-status-page-component-sources": {
|
|
1748
3672
|
parameters: {
|
|
1749
3673
|
query?: never;
|
|
1750
3674
|
header?: never;
|
|
1751
3675
|
path: {
|
|
1752
|
-
|
|
3676
|
+
componentId: string;
|
|
1753
3677
|
};
|
|
1754
3678
|
cookie?: never;
|
|
1755
3679
|
};
|
|
1756
|
-
requestBody
|
|
3680
|
+
requestBody: {
|
|
3681
|
+
content: {
|
|
3682
|
+
"application/json": components["schemas"]["PutStatusPageComponentSourcesRequestBody"];
|
|
3683
|
+
};
|
|
3684
|
+
};
|
|
1757
3685
|
responses: {
|
|
1758
3686
|
/** @description OK */
|
|
1759
3687
|
200: {
|
|
@@ -1761,7 +3689,7 @@ export interface operations {
|
|
|
1761
3689
|
[name: string]: unknown;
|
|
1762
3690
|
};
|
|
1763
3691
|
content: {
|
|
1764
|
-
"application/json": components["schemas"]["
|
|
3692
|
+
"application/json": components["schemas"]["StatusPageComponentSourcesResource"];
|
|
1765
3693
|
};
|
|
1766
3694
|
};
|
|
1767
3695
|
/** @description Error */
|
|
@@ -1775,12 +3703,12 @@ export interface operations {
|
|
|
1775
3703
|
};
|
|
1776
3704
|
};
|
|
1777
3705
|
};
|
|
1778
|
-
"list-
|
|
3706
|
+
"list-status-page-incidents": {
|
|
1779
3707
|
parameters: {
|
|
1780
|
-
query
|
|
1781
|
-
|
|
1782
|
-
/** @description 0 表示用默认 */
|
|
3708
|
+
query?: {
|
|
3709
|
+
/** @description Maximum number of records in this page */
|
|
1783
3710
|
limit?: number;
|
|
3711
|
+
offset?: number;
|
|
1784
3712
|
};
|
|
1785
3713
|
header?: never;
|
|
1786
3714
|
path?: never;
|
|
@@ -1794,7 +3722,7 @@ export interface operations {
|
|
|
1794
3722
|
[name: string]: unknown;
|
|
1795
3723
|
};
|
|
1796
3724
|
content: {
|
|
1797
|
-
"application/json": components["schemas"]["
|
|
3725
|
+
"application/json": components["schemas"]["LengthAwarePageStatusPageIncidentResource"];
|
|
1798
3726
|
};
|
|
1799
3727
|
};
|
|
1800
3728
|
/** @description Error */
|
|
@@ -1808,30 +3736,26 @@ export interface operations {
|
|
|
1808
3736
|
};
|
|
1809
3737
|
};
|
|
1810
3738
|
};
|
|
1811
|
-
"
|
|
3739
|
+
"publish-status-page-incident": {
|
|
1812
3740
|
parameters: {
|
|
1813
|
-
query?:
|
|
1814
|
-
/** @description 这一页最多返回多少条 */
|
|
1815
|
-
limit?: number;
|
|
1816
|
-
/** @description 跳过多少条。要翻得更深请改用游标翻页的接口 */
|
|
1817
|
-
offset?: number;
|
|
1818
|
-
/** @description 按名字或地址模糊匹配 */
|
|
1819
|
-
keyword?: string;
|
|
1820
|
-
monitoring_status?: "PENDING" | "ACTIVE" | "DISABLED" | "FAILED";
|
|
1821
|
-
};
|
|
3741
|
+
query?: never;
|
|
1822
3742
|
header?: never;
|
|
1823
3743
|
path?: never;
|
|
1824
3744
|
cookie?: never;
|
|
1825
3745
|
};
|
|
1826
|
-
requestBody
|
|
3746
|
+
requestBody: {
|
|
3747
|
+
content: {
|
|
3748
|
+
"application/json": components["schemas"]["PublishStatusPageIncidentRequestBody"];
|
|
3749
|
+
};
|
|
3750
|
+
};
|
|
1827
3751
|
responses: {
|
|
1828
|
-
/** @description
|
|
1829
|
-
|
|
3752
|
+
/** @description Created */
|
|
3753
|
+
201: {
|
|
1830
3754
|
headers: {
|
|
1831
3755
|
[name: string]: unknown;
|
|
1832
3756
|
};
|
|
1833
3757
|
content: {
|
|
1834
|
-
"application/json": components["schemas"]["
|
|
3758
|
+
"application/json": components["schemas"]["StatusPageIncidentResource"];
|
|
1835
3759
|
};
|
|
1836
3760
|
};
|
|
1837
3761
|
/** @description Error */
|
|
@@ -1845,12 +3769,12 @@ export interface operations {
|
|
|
1845
3769
|
};
|
|
1846
3770
|
};
|
|
1847
3771
|
};
|
|
1848
|
-
"get-
|
|
3772
|
+
"get-status-page-incident": {
|
|
1849
3773
|
parameters: {
|
|
1850
3774
|
query?: never;
|
|
1851
3775
|
header?: never;
|
|
1852
3776
|
path: {
|
|
1853
|
-
|
|
3777
|
+
incidentId: string;
|
|
1854
3778
|
};
|
|
1855
3779
|
cookie?: never;
|
|
1856
3780
|
};
|
|
@@ -1862,7 +3786,7 @@ export interface operations {
|
|
|
1862
3786
|
[name: string]: unknown;
|
|
1863
3787
|
};
|
|
1864
3788
|
content: {
|
|
1865
|
-
"application/json": components["schemas"]["
|
|
3789
|
+
"application/json": components["schemas"]["StatusPageIncidentResource"];
|
|
1866
3790
|
};
|
|
1867
3791
|
};
|
|
1868
3792
|
/** @description Error */
|
|
@@ -1876,18 +3800,18 @@ export interface operations {
|
|
|
1876
3800
|
};
|
|
1877
3801
|
};
|
|
1878
3802
|
};
|
|
1879
|
-
"
|
|
3803
|
+
"post-status-page-incident-update": {
|
|
1880
3804
|
parameters: {
|
|
1881
3805
|
query?: never;
|
|
1882
3806
|
header?: never;
|
|
1883
3807
|
path: {
|
|
1884
|
-
|
|
3808
|
+
incidentId: string;
|
|
1885
3809
|
};
|
|
1886
3810
|
cookie?: never;
|
|
1887
3811
|
};
|
|
1888
3812
|
requestBody: {
|
|
1889
3813
|
content: {
|
|
1890
|
-
"application/json": components["schemas"]["
|
|
3814
|
+
"application/json": components["schemas"]["PostStatusPageIncidentUpdateRequestBody"];
|
|
1891
3815
|
};
|
|
1892
3816
|
};
|
|
1893
3817
|
responses: {
|
|
@@ -1897,7 +3821,7 @@ export interface operations {
|
|
|
1897
3821
|
[name: string]: unknown;
|
|
1898
3822
|
};
|
|
1899
3823
|
content: {
|
|
1900
|
-
"application/json": components["schemas"]["
|
|
3824
|
+
"application/json": components["schemas"]["StatusPageIncidentResource"];
|
|
1901
3825
|
};
|
|
1902
3826
|
};
|
|
1903
3827
|
/** @description Error */
|
|
@@ -1911,23 +3835,27 @@ export interface operations {
|
|
|
1911
3835
|
};
|
|
1912
3836
|
};
|
|
1913
3837
|
};
|
|
1914
|
-
"
|
|
3838
|
+
"list-status-page-maintenances": {
|
|
1915
3839
|
parameters: {
|
|
1916
|
-
query?:
|
|
1917
|
-
|
|
1918
|
-
|
|
1919
|
-
|
|
3840
|
+
query?: {
|
|
3841
|
+
/** @description Maximum number of records in this page */
|
|
3842
|
+
limit?: number;
|
|
3843
|
+
offset?: number;
|
|
1920
3844
|
};
|
|
3845
|
+
header?: never;
|
|
3846
|
+
path?: never;
|
|
1921
3847
|
cookie?: never;
|
|
1922
3848
|
};
|
|
1923
3849
|
requestBody?: never;
|
|
1924
3850
|
responses: {
|
|
1925
|
-
/** @description
|
|
1926
|
-
|
|
3851
|
+
/** @description OK */
|
|
3852
|
+
200: {
|
|
1927
3853
|
headers: {
|
|
1928
3854
|
[name: string]: unknown;
|
|
1929
3855
|
};
|
|
1930
|
-
content
|
|
3856
|
+
content: {
|
|
3857
|
+
"application/json": components["schemas"]["LengthAwarePageStatusPageMaintenanceResource"];
|
|
3858
|
+
};
|
|
1931
3859
|
};
|
|
1932
3860
|
/** @description Error */
|
|
1933
3861
|
default: {
|
|
@@ -1940,28 +3868,26 @@ export interface operations {
|
|
|
1940
3868
|
};
|
|
1941
3869
|
};
|
|
1942
3870
|
};
|
|
1943
|
-
"
|
|
3871
|
+
"schedule-status-page-maintenance": {
|
|
1944
3872
|
parameters: {
|
|
1945
3873
|
query?: never;
|
|
1946
3874
|
header?: never;
|
|
1947
|
-
path
|
|
1948
|
-
serverId: string;
|
|
1949
|
-
};
|
|
3875
|
+
path?: never;
|
|
1950
3876
|
cookie?: never;
|
|
1951
3877
|
};
|
|
1952
3878
|
requestBody: {
|
|
1953
3879
|
content: {
|
|
1954
|
-
"application/json": components["schemas"]["
|
|
3880
|
+
"application/json": components["schemas"]["ScheduleStatusPageMaintenanceRequestBody"];
|
|
1955
3881
|
};
|
|
1956
3882
|
};
|
|
1957
3883
|
responses: {
|
|
1958
|
-
/** @description
|
|
1959
|
-
|
|
3884
|
+
/** @description Created */
|
|
3885
|
+
201: {
|
|
1960
3886
|
headers: {
|
|
1961
3887
|
[name: string]: unknown;
|
|
1962
3888
|
};
|
|
1963
3889
|
content: {
|
|
1964
|
-
"application/json": components["schemas"]["
|
|
3890
|
+
"application/json": components["schemas"]["StatusPageMaintenanceResource"];
|
|
1965
3891
|
};
|
|
1966
3892
|
};
|
|
1967
3893
|
/** @description Error */
|
|
@@ -1975,23 +3901,25 @@ export interface operations {
|
|
|
1975
3901
|
};
|
|
1976
3902
|
};
|
|
1977
3903
|
};
|
|
1978
|
-
"
|
|
3904
|
+
"get-status-page-maintenance": {
|
|
1979
3905
|
parameters: {
|
|
1980
3906
|
query?: never;
|
|
1981
3907
|
header?: never;
|
|
1982
3908
|
path: {
|
|
1983
|
-
|
|
3909
|
+
maintenanceId: string;
|
|
1984
3910
|
};
|
|
1985
3911
|
cookie?: never;
|
|
1986
3912
|
};
|
|
1987
3913
|
requestBody?: never;
|
|
1988
3914
|
responses: {
|
|
1989
|
-
/** @description
|
|
1990
|
-
|
|
3915
|
+
/** @description OK */
|
|
3916
|
+
200: {
|
|
1991
3917
|
headers: {
|
|
1992
3918
|
[name: string]: unknown;
|
|
1993
3919
|
};
|
|
1994
|
-
content
|
|
3920
|
+
content: {
|
|
3921
|
+
"application/json": components["schemas"]["StatusPageMaintenanceResource"];
|
|
3922
|
+
};
|
|
1995
3923
|
};
|
|
1996
3924
|
/** @description Error */
|
|
1997
3925
|
default: {
|
|
@@ -2004,12 +3932,12 @@ export interface operations {
|
|
|
2004
3932
|
};
|
|
2005
3933
|
};
|
|
2006
3934
|
};
|
|
2007
|
-
"
|
|
3935
|
+
"cancel-status-page-maintenance": {
|
|
2008
3936
|
parameters: {
|
|
2009
3937
|
query?: never;
|
|
2010
3938
|
header?: never;
|
|
2011
3939
|
path: {
|
|
2012
|
-
|
|
3940
|
+
maintenanceId: string;
|
|
2013
3941
|
};
|
|
2014
3942
|
cookie?: never;
|
|
2015
3943
|
};
|
|
@@ -2021,7 +3949,7 @@ export interface operations {
|
|
|
2021
3949
|
[name: string]: unknown;
|
|
2022
3950
|
};
|
|
2023
3951
|
content: {
|
|
2024
|
-
"application/json": components["schemas"]["
|
|
3952
|
+
"application/json": components["schemas"]["StatusPageMaintenanceResource"];
|
|
2025
3953
|
};
|
|
2026
3954
|
};
|
|
2027
3955
|
/** @description Error */
|
|
@@ -2035,13 +3963,12 @@ export interface operations {
|
|
|
2035
3963
|
};
|
|
2036
3964
|
};
|
|
2037
3965
|
};
|
|
2038
|
-
"
|
|
3966
|
+
"complete-status-page-maintenance": {
|
|
2039
3967
|
parameters: {
|
|
2040
3968
|
query?: never;
|
|
2041
3969
|
header?: never;
|
|
2042
3970
|
path: {
|
|
2043
|
-
|
|
2044
|
-
checkId: string;
|
|
3971
|
+
maintenanceId: string;
|
|
2045
3972
|
};
|
|
2046
3973
|
cookie?: never;
|
|
2047
3974
|
};
|
|
@@ -2053,7 +3980,7 @@ export interface operations {
|
|
|
2053
3980
|
[name: string]: unknown;
|
|
2054
3981
|
};
|
|
2055
3982
|
content: {
|
|
2056
|
-
"application/json": components["schemas"]["
|
|
3983
|
+
"application/json": components["schemas"]["StatusPageMaintenanceResource"];
|
|
2057
3984
|
};
|
|
2058
3985
|
};
|
|
2059
3986
|
/** @description Error */
|
|
@@ -2067,21 +3994,16 @@ export interface operations {
|
|
|
2067
3994
|
};
|
|
2068
3995
|
};
|
|
2069
3996
|
};
|
|
2070
|
-
"
|
|
3997
|
+
"get-project-web-check": {
|
|
2071
3998
|
parameters: {
|
|
2072
3999
|
query?: never;
|
|
2073
4000
|
header?: never;
|
|
2074
4001
|
path: {
|
|
2075
|
-
serverId: string;
|
|
2076
4002
|
checkId: string;
|
|
2077
4003
|
};
|
|
2078
4004
|
cookie?: never;
|
|
2079
4005
|
};
|
|
2080
|
-
requestBody
|
|
2081
|
-
content: {
|
|
2082
|
-
"application/json": components["schemas"]["PutWebCheckRequestBody"];
|
|
2083
|
-
};
|
|
2084
|
-
};
|
|
4006
|
+
requestBody?: never;
|
|
2085
4007
|
responses: {
|
|
2086
4008
|
/** @description OK */
|
|
2087
4009
|
200: {
|
|
@@ -2103,47 +4025,20 @@ export interface operations {
|
|
|
2103
4025
|
};
|
|
2104
4026
|
};
|
|
2105
4027
|
};
|
|
2106
|
-
"
|
|
4028
|
+
"put-project-web-check": {
|
|
2107
4029
|
parameters: {
|
|
2108
4030
|
query?: never;
|
|
2109
4031
|
header?: never;
|
|
2110
4032
|
path: {
|
|
2111
|
-
serverId: string;
|
|
2112
4033
|
checkId: string;
|
|
2113
4034
|
};
|
|
2114
4035
|
cookie?: never;
|
|
2115
4036
|
};
|
|
2116
|
-
requestBody
|
|
2117
|
-
|
|
2118
|
-
|
|
2119
|
-
204: {
|
|
2120
|
-
headers: {
|
|
2121
|
-
[name: string]: unknown;
|
|
2122
|
-
};
|
|
2123
|
-
content?: never;
|
|
2124
|
-
};
|
|
2125
|
-
/** @description Error */
|
|
2126
|
-
default: {
|
|
2127
|
-
headers: {
|
|
2128
|
-
[name: string]: unknown;
|
|
2129
|
-
};
|
|
2130
|
-
content: {
|
|
2131
|
-
"application/json": components["schemas"]["Error"];
|
|
2132
|
-
};
|
|
2133
|
-
};
|
|
2134
|
-
};
|
|
2135
|
-
};
|
|
2136
|
-
"list-web-checks": {
|
|
2137
|
-
parameters: {
|
|
2138
|
-
query?: {
|
|
2139
|
-
/** @description 只看某一台机器的检查;不给就是整个项目的 */
|
|
2140
|
-
server_id?: string;
|
|
4037
|
+
requestBody: {
|
|
4038
|
+
content: {
|
|
4039
|
+
"application/json": components["schemas"]["PutWebCheckRequestBody"];
|
|
2141
4040
|
};
|
|
2142
|
-
header?: never;
|
|
2143
|
-
path?: never;
|
|
2144
|
-
cookie?: never;
|
|
2145
4041
|
};
|
|
2146
|
-
requestBody?: never;
|
|
2147
4042
|
responses: {
|
|
2148
4043
|
/** @description OK */
|
|
2149
4044
|
200: {
|
|
@@ -2151,7 +4046,7 @@ export interface operations {
|
|
|
2151
4046
|
[name: string]: unknown;
|
|
2152
4047
|
};
|
|
2153
4048
|
content: {
|
|
2154
|
-
"application/json": components["schemas"]["
|
|
4049
|
+
"application/json": components["schemas"]["WebCheckResource"];
|
|
2155
4050
|
};
|
|
2156
4051
|
};
|
|
2157
4052
|
/** @description Error */
|
|
@@ -2165,28 +4060,23 @@ export interface operations {
|
|
|
2165
4060
|
};
|
|
2166
4061
|
};
|
|
2167
4062
|
};
|
|
2168
|
-
"
|
|
4063
|
+
"delete-project-web-check": {
|
|
2169
4064
|
parameters: {
|
|
2170
|
-
query?:
|
|
2171
|
-
from?: string;
|
|
2172
|
-
to?: string;
|
|
2173
|
-
/** @description 取最近 N 个完整周期,与 from/to 二选一 */
|
|
2174
|
-
periods?: number;
|
|
2175
|
-
};
|
|
4065
|
+
query?: never;
|
|
2176
4066
|
header?: never;
|
|
2177
|
-
path
|
|
4067
|
+
path: {
|
|
4068
|
+
checkId: string;
|
|
4069
|
+
};
|
|
2178
4070
|
cookie?: never;
|
|
2179
4071
|
};
|
|
2180
4072
|
requestBody?: never;
|
|
2181
4073
|
responses: {
|
|
2182
|
-
/** @description
|
|
2183
|
-
|
|
4074
|
+
/** @description No Content */
|
|
4075
|
+
204: {
|
|
2184
4076
|
headers: {
|
|
2185
4077
|
[name: string]: unknown;
|
|
2186
4078
|
};
|
|
2187
|
-
content
|
|
2188
|
-
"application/json": components["schemas"]["SLIReportResponseBody"];
|
|
2189
|
-
};
|
|
4079
|
+
content?: never;
|
|
2190
4080
|
};
|
|
2191
4081
|
/** @description Error */
|
|
2192
4082
|
default: {
|
|
@@ -2199,7 +4089,7 @@ export interface operations {
|
|
|
2199
4089
|
};
|
|
2200
4090
|
};
|
|
2201
4091
|
};
|
|
2202
|
-
"get-
|
|
4092
|
+
"get-status-page-domain": {
|
|
2203
4093
|
parameters: {
|
|
2204
4094
|
query?: never;
|
|
2205
4095
|
header?: never;
|
|
@@ -2214,7 +4104,7 @@ export interface operations {
|
|
|
2214
4104
|
[name: string]: unknown;
|
|
2215
4105
|
};
|
|
2216
4106
|
content: {
|
|
2217
|
-
"application/json": components["schemas"]["
|
|
4107
|
+
"application/json": components["schemas"]["StatusPageDomainResource"];
|
|
2218
4108
|
};
|
|
2219
4109
|
};
|
|
2220
4110
|
/** @description Error */
|
|
@@ -2228,7 +4118,7 @@ export interface operations {
|
|
|
2228
4118
|
};
|
|
2229
4119
|
};
|
|
2230
4120
|
};
|
|
2231
|
-
"put-
|
|
4121
|
+
"put-status-page-domain": {
|
|
2232
4122
|
parameters: {
|
|
2233
4123
|
query?: never;
|
|
2234
4124
|
header?: never;
|
|
@@ -2237,7 +4127,7 @@ export interface operations {
|
|
|
2237
4127
|
};
|
|
2238
4128
|
requestBody: {
|
|
2239
4129
|
content: {
|
|
2240
|
-
"application/json": components["schemas"]["
|
|
4130
|
+
"application/json": components["schemas"]["PutStatusPageDomainRequestBody"];
|
|
2241
4131
|
};
|
|
2242
4132
|
};
|
|
2243
4133
|
responses: {
|
|
@@ -2247,7 +4137,7 @@ export interface operations {
|
|
|
2247
4137
|
[name: string]: unknown;
|
|
2248
4138
|
};
|
|
2249
4139
|
content: {
|
|
2250
|
-
"application/json": components["schemas"]["
|
|
4140
|
+
"application/json": components["schemas"]["StatusPageDomainResource"];
|
|
2251
4141
|
};
|
|
2252
4142
|
};
|
|
2253
4143
|
/** @description Error */
|
|
@@ -2261,7 +4151,7 @@ export interface operations {
|
|
|
2261
4151
|
};
|
|
2262
4152
|
};
|
|
2263
4153
|
};
|
|
2264
|
-
"delete-
|
|
4154
|
+
"delete-status-page-domain": {
|
|
2265
4155
|
parameters: {
|
|
2266
4156
|
query?: never;
|
|
2267
4157
|
header?: never;
|