@belvador/api 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +27 -0
- package/README.md +54 -2
- package/dist/client.d.ts +70 -0
- package/dist/client.js +290 -0
- package/dist/errors.d.ts +36 -0
- package/dist/errors.js +73 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +3 -0
- package/dist/node-wire.gen.d.ts +41 -0
- package/dist/node-wire.gen.js +100 -0
- package/dist/operations.gen.d.ts +2285 -0
- package/dist/operations.gen.js +1447 -0
- package/package.json +41 -4
|
@@ -0,0 +1,2285 @@
|
|
|
1
|
+
/** Version of the OpenAPI document this client was generated from. */
|
|
2
|
+
export declare const API_VERSION = "1.0.0";
|
|
3
|
+
export type HttpMethod = "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
|
|
4
|
+
export type OperationMeta = {
|
|
5
|
+
method: HttpMethod;
|
|
6
|
+
/** `/v1/...` with `{snake_name}` path parameters. */
|
|
7
|
+
path: string;
|
|
8
|
+
pathParams: readonly string[];
|
|
9
|
+
/** Scope the credential needs. */
|
|
10
|
+
scope: string;
|
|
11
|
+
kind: "read" | "write" | "node";
|
|
12
|
+
/** `approval`: answers 403 APPROVAL_REQUIRED until a person approves it on belvador.dev. */
|
|
13
|
+
sensitivity: string;
|
|
14
|
+
idempotency: "required" | "optional" | "none";
|
|
15
|
+
ifMatch: boolean;
|
|
16
|
+
/** List answers `{data, next_cursor, complete}`. */
|
|
17
|
+
paged: boolean;
|
|
18
|
+
status: number;
|
|
19
|
+
/** Node data: the node route a ticket holder can call directly (`""` = the ticket itself). */
|
|
20
|
+
node: {
|
|
21
|
+
path: string;
|
|
22
|
+
list?: string;
|
|
23
|
+
window?: boolean;
|
|
24
|
+
} | null;
|
|
25
|
+
/** Wire-named input defaults, applied before a direct node read. */
|
|
26
|
+
defaults: Readonly<Record<string, string | number | boolean>>;
|
|
27
|
+
};
|
|
28
|
+
export declare const OPERATIONS: {
|
|
29
|
+
readonly "alert_deliveries.replay": {
|
|
30
|
+
readonly method: "POST";
|
|
31
|
+
readonly path: "/v1/alert-deliveries/{delivery_id}/replay";
|
|
32
|
+
readonly pathParams: readonly ["delivery_id"];
|
|
33
|
+
readonly scope: "alerts:write";
|
|
34
|
+
readonly kind: "write";
|
|
35
|
+
readonly sensitivity: "normal";
|
|
36
|
+
readonly idempotency: "optional";
|
|
37
|
+
readonly ifMatch: false;
|
|
38
|
+
readonly paged: false;
|
|
39
|
+
readonly status: 200;
|
|
40
|
+
readonly node: null;
|
|
41
|
+
readonly defaults: {};
|
|
42
|
+
};
|
|
43
|
+
readonly "alert_rules.delete": {
|
|
44
|
+
readonly method: "DELETE";
|
|
45
|
+
readonly path: "/v1/alert-rules/{rule_id}";
|
|
46
|
+
readonly pathParams: readonly ["rule_id"];
|
|
47
|
+
readonly scope: "alerts:write";
|
|
48
|
+
readonly kind: "write";
|
|
49
|
+
readonly sensitivity: "normal";
|
|
50
|
+
readonly idempotency: "none";
|
|
51
|
+
readonly ifMatch: true;
|
|
52
|
+
readonly paged: false;
|
|
53
|
+
readonly status: 200;
|
|
54
|
+
readonly node: null;
|
|
55
|
+
readonly defaults: {};
|
|
56
|
+
};
|
|
57
|
+
readonly "alert_rules.list": {
|
|
58
|
+
readonly method: "GET";
|
|
59
|
+
readonly path: "/v1/alert-rules";
|
|
60
|
+
readonly pathParams: readonly [];
|
|
61
|
+
readonly scope: "alerts:read";
|
|
62
|
+
readonly kind: "read";
|
|
63
|
+
readonly sensitivity: "normal";
|
|
64
|
+
readonly idempotency: "none";
|
|
65
|
+
readonly ifMatch: false;
|
|
66
|
+
readonly paged: true;
|
|
67
|
+
readonly status: 200;
|
|
68
|
+
readonly node: null;
|
|
69
|
+
readonly defaults: {};
|
|
70
|
+
};
|
|
71
|
+
readonly "alert_rules.save": {
|
|
72
|
+
readonly method: "POST";
|
|
73
|
+
readonly path: "/v1/alert-rules";
|
|
74
|
+
readonly pathParams: readonly [];
|
|
75
|
+
readonly scope: "alerts:write";
|
|
76
|
+
readonly kind: "write";
|
|
77
|
+
readonly sensitivity: "normal";
|
|
78
|
+
readonly idempotency: "optional";
|
|
79
|
+
readonly ifMatch: false;
|
|
80
|
+
readonly paged: false;
|
|
81
|
+
readonly status: 200;
|
|
82
|
+
readonly node: null;
|
|
83
|
+
readonly defaults: {};
|
|
84
|
+
};
|
|
85
|
+
readonly "alert_rules.set_enabled": {
|
|
86
|
+
readonly method: "PUT";
|
|
87
|
+
readonly path: "/v1/alert-rules/{rule_id}/enabled";
|
|
88
|
+
readonly pathParams: readonly ["rule_id"];
|
|
89
|
+
readonly scope: "alerts:write";
|
|
90
|
+
readonly kind: "write";
|
|
91
|
+
readonly sensitivity: "normal";
|
|
92
|
+
readonly idempotency: "none";
|
|
93
|
+
readonly ifMatch: false;
|
|
94
|
+
readonly paged: false;
|
|
95
|
+
readonly status: 200;
|
|
96
|
+
readonly node: null;
|
|
97
|
+
readonly defaults: {};
|
|
98
|
+
};
|
|
99
|
+
readonly "alerts.list": {
|
|
100
|
+
readonly method: "GET";
|
|
101
|
+
readonly path: "/v1/alerts";
|
|
102
|
+
readonly pathParams: readonly [];
|
|
103
|
+
readonly scope: "alerts:read";
|
|
104
|
+
readonly kind: "read";
|
|
105
|
+
readonly sensitivity: "normal";
|
|
106
|
+
readonly idempotency: "none";
|
|
107
|
+
readonly ifMatch: false;
|
|
108
|
+
readonly paged: true;
|
|
109
|
+
readonly status: 200;
|
|
110
|
+
readonly node: null;
|
|
111
|
+
readonly defaults: {};
|
|
112
|
+
};
|
|
113
|
+
readonly "audit.list": {
|
|
114
|
+
readonly method: "GET";
|
|
115
|
+
readonly path: "/v1/audit-log";
|
|
116
|
+
readonly pathParams: readonly [];
|
|
117
|
+
readonly scope: "audit:read";
|
|
118
|
+
readonly kind: "read";
|
|
119
|
+
readonly sensitivity: "normal";
|
|
120
|
+
readonly idempotency: "none";
|
|
121
|
+
readonly ifMatch: false;
|
|
122
|
+
readonly paged: true;
|
|
123
|
+
readonly status: 200;
|
|
124
|
+
readonly node: null;
|
|
125
|
+
readonly defaults: {};
|
|
126
|
+
};
|
|
127
|
+
readonly "destinations.create": {
|
|
128
|
+
readonly method: "POST";
|
|
129
|
+
readonly path: "/v1/destinations";
|
|
130
|
+
readonly pathParams: readonly [];
|
|
131
|
+
readonly scope: "destinations:manage";
|
|
132
|
+
readonly kind: "write";
|
|
133
|
+
readonly sensitivity: "approval";
|
|
134
|
+
readonly idempotency: "required";
|
|
135
|
+
readonly ifMatch: false;
|
|
136
|
+
readonly paged: false;
|
|
137
|
+
readonly status: 201;
|
|
138
|
+
readonly node: null;
|
|
139
|
+
readonly defaults: {};
|
|
140
|
+
};
|
|
141
|
+
readonly "destinations.delete": {
|
|
142
|
+
readonly method: "DELETE";
|
|
143
|
+
readonly path: "/v1/destinations/{destination_id}";
|
|
144
|
+
readonly pathParams: readonly ["destination_id"];
|
|
145
|
+
readonly scope: "destinations:manage";
|
|
146
|
+
readonly kind: "write";
|
|
147
|
+
readonly sensitivity: "approval";
|
|
148
|
+
readonly idempotency: "none";
|
|
149
|
+
readonly ifMatch: false;
|
|
150
|
+
readonly paged: false;
|
|
151
|
+
readonly status: 200;
|
|
152
|
+
readonly node: null;
|
|
153
|
+
readonly defaults: {};
|
|
154
|
+
};
|
|
155
|
+
readonly "destinations.list": {
|
|
156
|
+
readonly method: "GET";
|
|
157
|
+
readonly path: "/v1/destinations";
|
|
158
|
+
readonly pathParams: readonly [];
|
|
159
|
+
readonly scope: "alerts:read";
|
|
160
|
+
readonly kind: "read";
|
|
161
|
+
readonly sensitivity: "normal";
|
|
162
|
+
readonly idempotency: "none";
|
|
163
|
+
readonly ifMatch: false;
|
|
164
|
+
readonly paged: true;
|
|
165
|
+
readonly status: 200;
|
|
166
|
+
readonly node: null;
|
|
167
|
+
readonly defaults: {};
|
|
168
|
+
};
|
|
169
|
+
readonly "destinations.resend_confirmation": {
|
|
170
|
+
readonly method: "POST";
|
|
171
|
+
readonly path: "/v1/destination-recipients/{recipient_id}/resend";
|
|
172
|
+
readonly pathParams: readonly ["recipient_id"];
|
|
173
|
+
readonly scope: "destinations:manage";
|
|
174
|
+
readonly kind: "write";
|
|
175
|
+
readonly sensitivity: "normal";
|
|
176
|
+
readonly idempotency: "optional";
|
|
177
|
+
readonly ifMatch: false;
|
|
178
|
+
readonly paged: false;
|
|
179
|
+
readonly status: 200;
|
|
180
|
+
readonly node: null;
|
|
181
|
+
readonly defaults: {};
|
|
182
|
+
};
|
|
183
|
+
readonly "destinations.send_test": {
|
|
184
|
+
readonly method: "POST";
|
|
185
|
+
readonly path: "/v1/destinations/{destination_id}/test";
|
|
186
|
+
readonly pathParams: readonly ["destination_id"];
|
|
187
|
+
readonly scope: "notifications:write";
|
|
188
|
+
readonly kind: "write";
|
|
189
|
+
readonly sensitivity: "normal";
|
|
190
|
+
readonly idempotency: "optional";
|
|
191
|
+
readonly ifMatch: false;
|
|
192
|
+
readonly paged: false;
|
|
193
|
+
readonly status: 200;
|
|
194
|
+
readonly node: null;
|
|
195
|
+
readonly defaults: {};
|
|
196
|
+
};
|
|
197
|
+
readonly "destinations.set_recipients": {
|
|
198
|
+
readonly method: "PUT";
|
|
199
|
+
readonly path: "/v1/destinations/{destination_id}/recipients";
|
|
200
|
+
readonly pathParams: readonly ["destination_id"];
|
|
201
|
+
readonly scope: "destinations:manage";
|
|
202
|
+
readonly kind: "write";
|
|
203
|
+
readonly sensitivity: "approval";
|
|
204
|
+
readonly idempotency: "none";
|
|
205
|
+
readonly ifMatch: false;
|
|
206
|
+
readonly paged: false;
|
|
207
|
+
readonly status: 200;
|
|
208
|
+
readonly node: null;
|
|
209
|
+
readonly defaults: {};
|
|
210
|
+
};
|
|
211
|
+
readonly "destinations.update": {
|
|
212
|
+
readonly method: "PATCH";
|
|
213
|
+
readonly path: "/v1/destinations/{destination_id}";
|
|
214
|
+
readonly pathParams: readonly ["destination_id"];
|
|
215
|
+
readonly scope: "destinations:manage";
|
|
216
|
+
readonly kind: "write";
|
|
217
|
+
readonly sensitivity: "approval";
|
|
218
|
+
readonly idempotency: "none";
|
|
219
|
+
readonly ifMatch: false;
|
|
220
|
+
readonly paged: false;
|
|
221
|
+
readonly status: 200;
|
|
222
|
+
readonly node: null;
|
|
223
|
+
readonly defaults: {};
|
|
224
|
+
};
|
|
225
|
+
readonly "destinations.update_connection": {
|
|
226
|
+
readonly method: "POST";
|
|
227
|
+
readonly path: "/v1/destinations/{destination_id}/connection";
|
|
228
|
+
readonly pathParams: readonly ["destination_id"];
|
|
229
|
+
readonly scope: "destinations:manage";
|
|
230
|
+
readonly kind: "write";
|
|
231
|
+
readonly sensitivity: "approval";
|
|
232
|
+
readonly idempotency: "optional";
|
|
233
|
+
readonly ifMatch: false;
|
|
234
|
+
readonly paged: false;
|
|
235
|
+
readonly status: 200;
|
|
236
|
+
readonly node: null;
|
|
237
|
+
readonly defaults: {};
|
|
238
|
+
};
|
|
239
|
+
readonly "events.get": {
|
|
240
|
+
readonly method: "GET";
|
|
241
|
+
readonly path: "/v1/issues/{issue_id}/events/{event_id}";
|
|
242
|
+
readonly pathParams: readonly ["issue_id", "event_id"];
|
|
243
|
+
readonly scope: "events:read";
|
|
244
|
+
readonly kind: "node";
|
|
245
|
+
readonly sensitivity: "normal";
|
|
246
|
+
readonly idempotency: "none";
|
|
247
|
+
readonly ifMatch: false;
|
|
248
|
+
readonly paged: false;
|
|
249
|
+
readonly status: 200;
|
|
250
|
+
readonly node: {
|
|
251
|
+
readonly path: "q/issues/{issue_id}/events/{event_id}";
|
|
252
|
+
};
|
|
253
|
+
readonly defaults: {};
|
|
254
|
+
};
|
|
255
|
+
readonly "events.list": {
|
|
256
|
+
readonly method: "GET";
|
|
257
|
+
readonly path: "/v1/issues/{issue_id}/events";
|
|
258
|
+
readonly pathParams: readonly ["issue_id"];
|
|
259
|
+
readonly scope: "events:read";
|
|
260
|
+
readonly kind: "node";
|
|
261
|
+
readonly sensitivity: "normal";
|
|
262
|
+
readonly idempotency: "none";
|
|
263
|
+
readonly ifMatch: false;
|
|
264
|
+
readonly paged: true;
|
|
265
|
+
readonly status: 200;
|
|
266
|
+
readonly node: {
|
|
267
|
+
readonly path: "q/issues/{issue_id}/events";
|
|
268
|
+
readonly list: "events";
|
|
269
|
+
};
|
|
270
|
+
readonly defaults: {};
|
|
271
|
+
};
|
|
272
|
+
readonly "ingest_keys.create": {
|
|
273
|
+
readonly method: "POST";
|
|
274
|
+
readonly path: "/v1/projects/{project_id}/ingest-keys";
|
|
275
|
+
readonly pathParams: readonly ["project_id"];
|
|
276
|
+
readonly scope: "keys:manage";
|
|
277
|
+
readonly kind: "write";
|
|
278
|
+
readonly sensitivity: "approval";
|
|
279
|
+
readonly idempotency: "required";
|
|
280
|
+
readonly ifMatch: false;
|
|
281
|
+
readonly paged: false;
|
|
282
|
+
readonly status: 201;
|
|
283
|
+
readonly node: null;
|
|
284
|
+
readonly defaults: {};
|
|
285
|
+
};
|
|
286
|
+
readonly "ingest_keys.revoke": {
|
|
287
|
+
readonly method: "DELETE";
|
|
288
|
+
readonly path: "/v1/ingest-keys/{key_id}";
|
|
289
|
+
readonly pathParams: readonly ["key_id"];
|
|
290
|
+
readonly scope: "keys:manage";
|
|
291
|
+
readonly kind: "write";
|
|
292
|
+
readonly sensitivity: "approval";
|
|
293
|
+
readonly idempotency: "none";
|
|
294
|
+
readonly ifMatch: false;
|
|
295
|
+
readonly paged: false;
|
|
296
|
+
readonly status: 200;
|
|
297
|
+
readonly node: null;
|
|
298
|
+
readonly defaults: {};
|
|
299
|
+
};
|
|
300
|
+
readonly "invites.create": {
|
|
301
|
+
readonly method: "POST";
|
|
302
|
+
readonly path: "/v1/invites";
|
|
303
|
+
readonly pathParams: readonly [];
|
|
304
|
+
readonly scope: "members:manage";
|
|
305
|
+
readonly kind: "write";
|
|
306
|
+
readonly sensitivity: "approval";
|
|
307
|
+
readonly idempotency: "required";
|
|
308
|
+
readonly ifMatch: false;
|
|
309
|
+
readonly paged: false;
|
|
310
|
+
readonly status: 201;
|
|
311
|
+
readonly node: null;
|
|
312
|
+
readonly defaults: {};
|
|
313
|
+
};
|
|
314
|
+
readonly "invites.revoke": {
|
|
315
|
+
readonly method: "DELETE";
|
|
316
|
+
readonly path: "/v1/invites/{invite_id}";
|
|
317
|
+
readonly pathParams: readonly ["invite_id"];
|
|
318
|
+
readonly scope: "members:manage";
|
|
319
|
+
readonly kind: "write";
|
|
320
|
+
readonly sensitivity: "normal";
|
|
321
|
+
readonly idempotency: "none";
|
|
322
|
+
readonly ifMatch: false;
|
|
323
|
+
readonly paged: false;
|
|
324
|
+
readonly status: 200;
|
|
325
|
+
readonly node: null;
|
|
326
|
+
readonly defaults: {};
|
|
327
|
+
};
|
|
328
|
+
readonly "issues.activity": {
|
|
329
|
+
readonly method: "GET";
|
|
330
|
+
readonly path: "/v1/issues/{issue_id}/activity";
|
|
331
|
+
readonly pathParams: readonly ["issue_id"];
|
|
332
|
+
readonly scope: "issues:read";
|
|
333
|
+
readonly kind: "node";
|
|
334
|
+
readonly sensitivity: "normal";
|
|
335
|
+
readonly idempotency: "none";
|
|
336
|
+
readonly ifMatch: false;
|
|
337
|
+
readonly paged: false;
|
|
338
|
+
readonly status: 200;
|
|
339
|
+
readonly node: {
|
|
340
|
+
readonly path: "q/issues/{issue_id}/activity";
|
|
341
|
+
};
|
|
342
|
+
readonly defaults: {};
|
|
343
|
+
};
|
|
344
|
+
readonly "issues.bulk_update": {
|
|
345
|
+
readonly method: "POST";
|
|
346
|
+
readonly path: "/v1/issues/bulk";
|
|
347
|
+
readonly pathParams: readonly [];
|
|
348
|
+
readonly scope: "issues:write";
|
|
349
|
+
readonly kind: "node";
|
|
350
|
+
readonly sensitivity: "normal";
|
|
351
|
+
readonly idempotency: "none";
|
|
352
|
+
readonly ifMatch: false;
|
|
353
|
+
readonly paged: false;
|
|
354
|
+
readonly status: 200;
|
|
355
|
+
readonly node: {
|
|
356
|
+
readonly path: "w/issues/bulk";
|
|
357
|
+
};
|
|
358
|
+
readonly defaults: {};
|
|
359
|
+
};
|
|
360
|
+
readonly "issues.get": {
|
|
361
|
+
readonly method: "GET";
|
|
362
|
+
readonly path: "/v1/issues/{issue_id}";
|
|
363
|
+
readonly pathParams: readonly ["issue_id"];
|
|
364
|
+
readonly scope: "issues:read";
|
|
365
|
+
readonly kind: "node";
|
|
366
|
+
readonly sensitivity: "normal";
|
|
367
|
+
readonly idempotency: "none";
|
|
368
|
+
readonly ifMatch: false;
|
|
369
|
+
readonly paged: false;
|
|
370
|
+
readonly status: 200;
|
|
371
|
+
readonly node: {
|
|
372
|
+
readonly path: "q/issues/{issue_id}";
|
|
373
|
+
};
|
|
374
|
+
readonly defaults: {};
|
|
375
|
+
};
|
|
376
|
+
readonly "issues.list": {
|
|
377
|
+
readonly method: "GET";
|
|
378
|
+
readonly path: "/v1/issues";
|
|
379
|
+
readonly pathParams: readonly [];
|
|
380
|
+
readonly scope: "issues:read";
|
|
381
|
+
readonly kind: "node";
|
|
382
|
+
readonly sensitivity: "normal";
|
|
383
|
+
readonly idempotency: "none";
|
|
384
|
+
readonly ifMatch: false;
|
|
385
|
+
readonly paged: true;
|
|
386
|
+
readonly status: 200;
|
|
387
|
+
readonly node: {
|
|
388
|
+
readonly path: "q/issues";
|
|
389
|
+
readonly list: "issues";
|
|
390
|
+
};
|
|
391
|
+
readonly defaults: {};
|
|
392
|
+
};
|
|
393
|
+
readonly "issues.stats": {
|
|
394
|
+
readonly method: "GET";
|
|
395
|
+
readonly path: "/v1/issues/{issue_id}/stats";
|
|
396
|
+
readonly pathParams: readonly ["issue_id"];
|
|
397
|
+
readonly scope: "issues:read";
|
|
398
|
+
readonly kind: "node";
|
|
399
|
+
readonly sensitivity: "normal";
|
|
400
|
+
readonly idempotency: "none";
|
|
401
|
+
readonly ifMatch: false;
|
|
402
|
+
readonly paged: false;
|
|
403
|
+
readonly status: 200;
|
|
404
|
+
readonly node: {
|
|
405
|
+
readonly path: "q/issues/{issue_id}/stats";
|
|
406
|
+
};
|
|
407
|
+
readonly defaults: {};
|
|
408
|
+
};
|
|
409
|
+
readonly "issues.tags": {
|
|
410
|
+
readonly method: "GET";
|
|
411
|
+
readonly path: "/v1/issues/{issue_id}/tags";
|
|
412
|
+
readonly pathParams: readonly ["issue_id"];
|
|
413
|
+
readonly scope: "issues:read";
|
|
414
|
+
readonly kind: "node";
|
|
415
|
+
readonly sensitivity: "normal";
|
|
416
|
+
readonly idempotency: "none";
|
|
417
|
+
readonly ifMatch: false;
|
|
418
|
+
readonly paged: false;
|
|
419
|
+
readonly status: 200;
|
|
420
|
+
readonly node: {
|
|
421
|
+
readonly path: "q/issues/{issue_id}/tags";
|
|
422
|
+
};
|
|
423
|
+
readonly defaults: {};
|
|
424
|
+
};
|
|
425
|
+
readonly "issues.update": {
|
|
426
|
+
readonly method: "PATCH";
|
|
427
|
+
readonly path: "/v1/issues/{issue_id}";
|
|
428
|
+
readonly pathParams: readonly ["issue_id"];
|
|
429
|
+
readonly scope: "issues:write";
|
|
430
|
+
readonly kind: "node";
|
|
431
|
+
readonly sensitivity: "normal";
|
|
432
|
+
readonly idempotency: "none";
|
|
433
|
+
readonly ifMatch: false;
|
|
434
|
+
readonly paged: false;
|
|
435
|
+
readonly status: 200;
|
|
436
|
+
readonly node: {
|
|
437
|
+
readonly path: "w/issues/{issue_id}";
|
|
438
|
+
};
|
|
439
|
+
readonly defaults: {};
|
|
440
|
+
};
|
|
441
|
+
readonly "logs.around": {
|
|
442
|
+
readonly method: "GET";
|
|
443
|
+
readonly path: "/v1/logs/{log_id}/around";
|
|
444
|
+
readonly pathParams: readonly ["log_id"];
|
|
445
|
+
readonly scope: "logs:read";
|
|
446
|
+
readonly kind: "node";
|
|
447
|
+
readonly sensitivity: "normal";
|
|
448
|
+
readonly idempotency: "none";
|
|
449
|
+
readonly ifMatch: false;
|
|
450
|
+
readonly paged: false;
|
|
451
|
+
readonly status: 200;
|
|
452
|
+
readonly node: {
|
|
453
|
+
readonly path: "q/logs/{log_id}/around";
|
|
454
|
+
};
|
|
455
|
+
readonly defaults: {};
|
|
456
|
+
};
|
|
457
|
+
readonly "logs.facets": {
|
|
458
|
+
readonly method: "GET";
|
|
459
|
+
readonly path: "/v1/logs/facets";
|
|
460
|
+
readonly pathParams: readonly [];
|
|
461
|
+
readonly scope: "logs:read";
|
|
462
|
+
readonly kind: "node";
|
|
463
|
+
readonly sensitivity: "normal";
|
|
464
|
+
readonly idempotency: "none";
|
|
465
|
+
readonly ifMatch: false;
|
|
466
|
+
readonly paged: false;
|
|
467
|
+
readonly status: 200;
|
|
468
|
+
readonly node: {
|
|
469
|
+
readonly path: "q/logs/facets";
|
|
470
|
+
readonly window: true;
|
|
471
|
+
};
|
|
472
|
+
readonly defaults: {};
|
|
473
|
+
};
|
|
474
|
+
readonly "logs.histogram": {
|
|
475
|
+
readonly method: "GET";
|
|
476
|
+
readonly path: "/v1/logs/histogram";
|
|
477
|
+
readonly pathParams: readonly [];
|
|
478
|
+
readonly scope: "logs:read";
|
|
479
|
+
readonly kind: "node";
|
|
480
|
+
readonly sensitivity: "normal";
|
|
481
|
+
readonly idempotency: "none";
|
|
482
|
+
readonly ifMatch: false;
|
|
483
|
+
readonly paged: false;
|
|
484
|
+
readonly status: 200;
|
|
485
|
+
readonly node: {
|
|
486
|
+
readonly path: "q/logs/histogram";
|
|
487
|
+
readonly window: true;
|
|
488
|
+
};
|
|
489
|
+
readonly defaults: {};
|
|
490
|
+
};
|
|
491
|
+
readonly "logs.list": {
|
|
492
|
+
readonly method: "GET";
|
|
493
|
+
readonly path: "/v1/logs";
|
|
494
|
+
readonly pathParams: readonly [];
|
|
495
|
+
readonly scope: "logs:read";
|
|
496
|
+
readonly kind: "node";
|
|
497
|
+
readonly sensitivity: "normal";
|
|
498
|
+
readonly idempotency: "none";
|
|
499
|
+
readonly ifMatch: false;
|
|
500
|
+
readonly paged: true;
|
|
501
|
+
readonly status: 200;
|
|
502
|
+
readonly node: {
|
|
503
|
+
readonly path: "q/logs";
|
|
504
|
+
readonly list: "logs";
|
|
505
|
+
readonly window: true;
|
|
506
|
+
};
|
|
507
|
+
readonly defaults: {};
|
|
508
|
+
};
|
|
509
|
+
readonly "members.change_role": {
|
|
510
|
+
readonly method: "PATCH";
|
|
511
|
+
readonly path: "/v1/members/{user_id}";
|
|
512
|
+
readonly pathParams: readonly ["user_id"];
|
|
513
|
+
readonly scope: "members:manage";
|
|
514
|
+
readonly kind: "write";
|
|
515
|
+
readonly sensitivity: "approval";
|
|
516
|
+
readonly idempotency: "none";
|
|
517
|
+
readonly ifMatch: false;
|
|
518
|
+
readonly paged: false;
|
|
519
|
+
readonly status: 200;
|
|
520
|
+
readonly node: null;
|
|
521
|
+
readonly defaults: {};
|
|
522
|
+
};
|
|
523
|
+
readonly "members.list": {
|
|
524
|
+
readonly method: "GET";
|
|
525
|
+
readonly path: "/v1/members";
|
|
526
|
+
readonly pathParams: readonly [];
|
|
527
|
+
readonly scope: "members:read";
|
|
528
|
+
readonly kind: "read";
|
|
529
|
+
readonly sensitivity: "normal";
|
|
530
|
+
readonly idempotency: "none";
|
|
531
|
+
readonly ifMatch: false;
|
|
532
|
+
readonly paged: true;
|
|
533
|
+
readonly status: 200;
|
|
534
|
+
readonly node: null;
|
|
535
|
+
readonly defaults: {};
|
|
536
|
+
};
|
|
537
|
+
readonly "members.remove": {
|
|
538
|
+
readonly method: "DELETE";
|
|
539
|
+
readonly path: "/v1/members/{user_id}";
|
|
540
|
+
readonly pathParams: readonly ["user_id"];
|
|
541
|
+
readonly scope: "members:manage";
|
|
542
|
+
readonly kind: "write";
|
|
543
|
+
readonly sensitivity: "approval";
|
|
544
|
+
readonly idempotency: "none";
|
|
545
|
+
readonly ifMatch: false;
|
|
546
|
+
readonly paged: false;
|
|
547
|
+
readonly status: 200;
|
|
548
|
+
readonly node: null;
|
|
549
|
+
readonly defaults: {};
|
|
550
|
+
};
|
|
551
|
+
readonly "monitors.create": {
|
|
552
|
+
readonly method: "POST";
|
|
553
|
+
readonly path: "/v1/monitors";
|
|
554
|
+
readonly pathParams: readonly [];
|
|
555
|
+
readonly scope: "monitors:write";
|
|
556
|
+
readonly kind: "write";
|
|
557
|
+
readonly sensitivity: "normal";
|
|
558
|
+
readonly idempotency: "required";
|
|
559
|
+
readonly ifMatch: false;
|
|
560
|
+
readonly paged: false;
|
|
561
|
+
readonly status: 201;
|
|
562
|
+
readonly node: null;
|
|
563
|
+
readonly defaults: {};
|
|
564
|
+
};
|
|
565
|
+
readonly "monitors.delete": {
|
|
566
|
+
readonly method: "DELETE";
|
|
567
|
+
readonly path: "/v1/monitors/{monitor_id}";
|
|
568
|
+
readonly pathParams: readonly ["monitor_id"];
|
|
569
|
+
readonly scope: "monitors:write";
|
|
570
|
+
readonly kind: "write";
|
|
571
|
+
readonly sensitivity: "normal";
|
|
572
|
+
readonly idempotency: "none";
|
|
573
|
+
readonly ifMatch: true;
|
|
574
|
+
readonly paged: false;
|
|
575
|
+
readonly status: 200;
|
|
576
|
+
readonly node: null;
|
|
577
|
+
readonly defaults: {};
|
|
578
|
+
};
|
|
579
|
+
readonly "monitors.dismiss_discovery": {
|
|
580
|
+
readonly method: "DELETE";
|
|
581
|
+
readonly path: "/v1/monitor-discoveries/{discovery_id}";
|
|
582
|
+
readonly pathParams: readonly ["discovery_id"];
|
|
583
|
+
readonly scope: "monitors:write";
|
|
584
|
+
readonly kind: "write";
|
|
585
|
+
readonly sensitivity: "normal";
|
|
586
|
+
readonly idempotency: "none";
|
|
587
|
+
readonly ifMatch: false;
|
|
588
|
+
readonly paged: false;
|
|
589
|
+
readonly status: 200;
|
|
590
|
+
readonly node: null;
|
|
591
|
+
readonly defaults: {};
|
|
592
|
+
};
|
|
593
|
+
readonly "monitors.get": {
|
|
594
|
+
readonly method: "GET";
|
|
595
|
+
readonly path: "/v1/monitors/{monitor_id}";
|
|
596
|
+
readonly pathParams: readonly ["monitor_id"];
|
|
597
|
+
readonly scope: "monitors:read";
|
|
598
|
+
readonly kind: "read";
|
|
599
|
+
readonly sensitivity: "normal";
|
|
600
|
+
readonly idempotency: "none";
|
|
601
|
+
readonly ifMatch: false;
|
|
602
|
+
readonly paged: false;
|
|
603
|
+
readonly status: 200;
|
|
604
|
+
readonly node: null;
|
|
605
|
+
readonly defaults: {};
|
|
606
|
+
};
|
|
607
|
+
readonly "monitors.list": {
|
|
608
|
+
readonly method: "GET";
|
|
609
|
+
readonly path: "/v1/monitors";
|
|
610
|
+
readonly pathParams: readonly [];
|
|
611
|
+
readonly scope: "monitors:read";
|
|
612
|
+
readonly kind: "read";
|
|
613
|
+
readonly sensitivity: "normal";
|
|
614
|
+
readonly idempotency: "none";
|
|
615
|
+
readonly ifMatch: false;
|
|
616
|
+
readonly paged: true;
|
|
617
|
+
readonly status: 200;
|
|
618
|
+
readonly node: null;
|
|
619
|
+
readonly defaults: {};
|
|
620
|
+
};
|
|
621
|
+
readonly "monitors.set_muted": {
|
|
622
|
+
readonly method: "PUT";
|
|
623
|
+
readonly path: "/v1/monitors/{monitor_id}/mute";
|
|
624
|
+
readonly pathParams: readonly ["monitor_id"];
|
|
625
|
+
readonly scope: "monitors:write";
|
|
626
|
+
readonly kind: "write";
|
|
627
|
+
readonly sensitivity: "normal";
|
|
628
|
+
readonly idempotency: "none";
|
|
629
|
+
readonly ifMatch: false;
|
|
630
|
+
readonly paged: false;
|
|
631
|
+
readonly status: 200;
|
|
632
|
+
readonly node: null;
|
|
633
|
+
readonly defaults: {};
|
|
634
|
+
};
|
|
635
|
+
readonly "monitors.set_pause": {
|
|
636
|
+
readonly method: "PUT";
|
|
637
|
+
readonly path: "/v1/monitors/{monitor_id}/pause";
|
|
638
|
+
readonly pathParams: readonly ["monitor_id"];
|
|
639
|
+
readonly scope: "monitors:write";
|
|
640
|
+
readonly kind: "write";
|
|
641
|
+
readonly sensitivity: "normal";
|
|
642
|
+
readonly idempotency: "none";
|
|
643
|
+
readonly ifMatch: false;
|
|
644
|
+
readonly paged: false;
|
|
645
|
+
readonly status: 200;
|
|
646
|
+
readonly node: null;
|
|
647
|
+
readonly defaults: {};
|
|
648
|
+
};
|
|
649
|
+
readonly "monitors.update": {
|
|
650
|
+
readonly method: "PATCH";
|
|
651
|
+
readonly path: "/v1/monitors/{monitor_id}";
|
|
652
|
+
readonly pathParams: readonly ["monitor_id"];
|
|
653
|
+
readonly scope: "monitors:write";
|
|
654
|
+
readonly kind: "write";
|
|
655
|
+
readonly sensitivity: "normal";
|
|
656
|
+
readonly idempotency: "none";
|
|
657
|
+
readonly ifMatch: true;
|
|
658
|
+
readonly paged: false;
|
|
659
|
+
readonly status: 200;
|
|
660
|
+
readonly node: null;
|
|
661
|
+
readonly defaults: {};
|
|
662
|
+
};
|
|
663
|
+
readonly "node.backup_now": {
|
|
664
|
+
readonly method: "POST";
|
|
665
|
+
readonly path: "/v1/node/backups";
|
|
666
|
+
readonly pathParams: readonly [];
|
|
667
|
+
readonly scope: "node:operate";
|
|
668
|
+
readonly kind: "write";
|
|
669
|
+
readonly sensitivity: "normal";
|
|
670
|
+
readonly idempotency: "optional";
|
|
671
|
+
readonly ifMatch: false;
|
|
672
|
+
readonly paged: false;
|
|
673
|
+
readonly status: 201;
|
|
674
|
+
readonly node: null;
|
|
675
|
+
readonly defaults: {};
|
|
676
|
+
};
|
|
677
|
+
readonly "node.cancel_deletion": {
|
|
678
|
+
readonly method: "POST";
|
|
679
|
+
readonly path: "/v1/node/{node_id}/restore";
|
|
680
|
+
readonly pathParams: readonly ["node_id"];
|
|
681
|
+
readonly scope: "node:operate";
|
|
682
|
+
readonly kind: "write";
|
|
683
|
+
readonly sensitivity: "normal";
|
|
684
|
+
readonly idempotency: "optional";
|
|
685
|
+
readonly ifMatch: false;
|
|
686
|
+
readonly paged: false;
|
|
687
|
+
readonly status: 200;
|
|
688
|
+
readonly node: null;
|
|
689
|
+
readonly defaults: {};
|
|
690
|
+
};
|
|
691
|
+
readonly "node.get": {
|
|
692
|
+
readonly method: "GET";
|
|
693
|
+
readonly path: "/v1/node";
|
|
694
|
+
readonly pathParams: readonly [];
|
|
695
|
+
readonly scope: "org:read";
|
|
696
|
+
readonly kind: "read";
|
|
697
|
+
readonly sensitivity: "normal";
|
|
698
|
+
readonly idempotency: "none";
|
|
699
|
+
readonly ifMatch: false;
|
|
700
|
+
readonly paged: false;
|
|
701
|
+
readonly status: 200;
|
|
702
|
+
readonly node: null;
|
|
703
|
+
readonly defaults: {};
|
|
704
|
+
};
|
|
705
|
+
readonly "node.provision": {
|
|
706
|
+
readonly method: "POST";
|
|
707
|
+
readonly path: "/v1/node";
|
|
708
|
+
readonly pathParams: readonly [];
|
|
709
|
+
readonly scope: "node:operate";
|
|
710
|
+
readonly kind: "write";
|
|
711
|
+
readonly sensitivity: "approval";
|
|
712
|
+
readonly idempotency: "required";
|
|
713
|
+
readonly ifMatch: false;
|
|
714
|
+
readonly paged: false;
|
|
715
|
+
readonly status: 201;
|
|
716
|
+
readonly node: null;
|
|
717
|
+
readonly defaults: {};
|
|
718
|
+
};
|
|
719
|
+
readonly "node.rebuild": {
|
|
720
|
+
readonly method: "POST";
|
|
721
|
+
readonly path: "/v1/node/{node_id}/rebuild";
|
|
722
|
+
readonly pathParams: readonly ["node_id"];
|
|
723
|
+
readonly scope: "node:operate";
|
|
724
|
+
readonly kind: "write";
|
|
725
|
+
readonly sensitivity: "approval";
|
|
726
|
+
readonly idempotency: "required";
|
|
727
|
+
readonly ifMatch: false;
|
|
728
|
+
readonly paged: false;
|
|
729
|
+
readonly status: 201;
|
|
730
|
+
readonly node: null;
|
|
731
|
+
readonly defaults: {};
|
|
732
|
+
};
|
|
733
|
+
readonly "node.resize": {
|
|
734
|
+
readonly method: "POST";
|
|
735
|
+
readonly path: "/v1/node/{node_id}/resize";
|
|
736
|
+
readonly pathParams: readonly ["node_id"];
|
|
737
|
+
readonly scope: "node:operate";
|
|
738
|
+
readonly kind: "write";
|
|
739
|
+
readonly sensitivity: "approval";
|
|
740
|
+
readonly idempotency: "optional";
|
|
741
|
+
readonly ifMatch: false;
|
|
742
|
+
readonly paged: false;
|
|
743
|
+
readonly status: 200;
|
|
744
|
+
readonly node: null;
|
|
745
|
+
readonly defaults: {};
|
|
746
|
+
};
|
|
747
|
+
readonly "node.retry_job": {
|
|
748
|
+
readonly method: "POST";
|
|
749
|
+
readonly path: "/v1/node/jobs/{job_id}/retry";
|
|
750
|
+
readonly pathParams: readonly ["job_id"];
|
|
751
|
+
readonly scope: "node:operate";
|
|
752
|
+
readonly kind: "write";
|
|
753
|
+
readonly sensitivity: "normal";
|
|
754
|
+
readonly idempotency: "optional";
|
|
755
|
+
readonly ifMatch: false;
|
|
756
|
+
readonly paged: false;
|
|
757
|
+
readonly status: 200;
|
|
758
|
+
readonly node: null;
|
|
759
|
+
readonly defaults: {};
|
|
760
|
+
};
|
|
761
|
+
readonly "node.schedule_deletion": {
|
|
762
|
+
readonly method: "DELETE";
|
|
763
|
+
readonly path: "/v1/node/{node_id}";
|
|
764
|
+
readonly pathParams: readonly ["node_id"];
|
|
765
|
+
readonly scope: "node:operate";
|
|
766
|
+
readonly kind: "write";
|
|
767
|
+
readonly sensitivity: "approval";
|
|
768
|
+
readonly idempotency: "none";
|
|
769
|
+
readonly ifMatch: false;
|
|
770
|
+
readonly paged: false;
|
|
771
|
+
readonly status: 200;
|
|
772
|
+
readonly node: null;
|
|
773
|
+
readonly defaults: {};
|
|
774
|
+
};
|
|
775
|
+
readonly "node.set_backup_custody": {
|
|
776
|
+
readonly method: "PUT";
|
|
777
|
+
readonly path: "/v1/node/backup-custody";
|
|
778
|
+
readonly pathParams: readonly [];
|
|
779
|
+
readonly scope: "node:operate";
|
|
780
|
+
readonly kind: "write";
|
|
781
|
+
readonly sensitivity: "approval";
|
|
782
|
+
readonly idempotency: "none";
|
|
783
|
+
readonly ifMatch: false;
|
|
784
|
+
readonly paged: false;
|
|
785
|
+
readonly status: 200;
|
|
786
|
+
readonly node: null;
|
|
787
|
+
readonly defaults: {};
|
|
788
|
+
};
|
|
789
|
+
readonly "node.submit_recovery_kit": {
|
|
790
|
+
readonly method: "POST";
|
|
791
|
+
readonly path: "/v1/node/jobs/{job_id}/recovery-kit";
|
|
792
|
+
readonly pathParams: readonly ["job_id"];
|
|
793
|
+
readonly scope: "node:operate";
|
|
794
|
+
readonly kind: "write";
|
|
795
|
+
readonly sensitivity: "approval";
|
|
796
|
+
readonly idempotency: "optional";
|
|
797
|
+
readonly ifMatch: false;
|
|
798
|
+
readonly paged: false;
|
|
799
|
+
readonly status: 200;
|
|
800
|
+
readonly node: null;
|
|
801
|
+
readonly defaults: {};
|
|
802
|
+
};
|
|
803
|
+
readonly "node.upgrade": {
|
|
804
|
+
readonly method: "POST";
|
|
805
|
+
readonly path: "/v1/node/{node_id}/upgrade";
|
|
806
|
+
readonly pathParams: readonly ["node_id"];
|
|
807
|
+
readonly scope: "node:operate";
|
|
808
|
+
readonly kind: "write";
|
|
809
|
+
readonly sensitivity: "normal";
|
|
810
|
+
readonly idempotency: "optional";
|
|
811
|
+
readonly ifMatch: false;
|
|
812
|
+
readonly paged: false;
|
|
813
|
+
readonly status: 200;
|
|
814
|
+
readonly node: null;
|
|
815
|
+
readonly defaults: {};
|
|
816
|
+
};
|
|
817
|
+
readonly "ping_tokens.reset": {
|
|
818
|
+
readonly method: "POST";
|
|
819
|
+
readonly path: "/v1/monitors/{monitor_id}/ping-tokens/reset";
|
|
820
|
+
readonly pathParams: readonly ["monitor_id"];
|
|
821
|
+
readonly scope: "keys:manage";
|
|
822
|
+
readonly kind: "write";
|
|
823
|
+
readonly sensitivity: "approval";
|
|
824
|
+
readonly idempotency: "optional";
|
|
825
|
+
readonly ifMatch: false;
|
|
826
|
+
readonly paged: false;
|
|
827
|
+
readonly status: 200;
|
|
828
|
+
readonly node: null;
|
|
829
|
+
readonly defaults: {};
|
|
830
|
+
};
|
|
831
|
+
readonly "ping_tokens.revoke_previous": {
|
|
832
|
+
readonly method: "POST";
|
|
833
|
+
readonly path: "/v1/monitors/{monitor_id}/ping-tokens/revoke-previous";
|
|
834
|
+
readonly pathParams: readonly ["monitor_id"];
|
|
835
|
+
readonly scope: "keys:manage";
|
|
836
|
+
readonly kind: "write";
|
|
837
|
+
readonly sensitivity: "approval";
|
|
838
|
+
readonly idempotency: "optional";
|
|
839
|
+
readonly ifMatch: false;
|
|
840
|
+
readonly paged: false;
|
|
841
|
+
readonly status: 200;
|
|
842
|
+
readonly node: null;
|
|
843
|
+
readonly defaults: {};
|
|
844
|
+
};
|
|
845
|
+
readonly "ping_tokens.rotate": {
|
|
846
|
+
readonly method: "POST";
|
|
847
|
+
readonly path: "/v1/monitors/{monitor_id}/ping-tokens/rotate";
|
|
848
|
+
readonly pathParams: readonly ["monitor_id"];
|
|
849
|
+
readonly scope: "keys:manage";
|
|
850
|
+
readonly kind: "write";
|
|
851
|
+
readonly sensitivity: "approval";
|
|
852
|
+
readonly idempotency: "optional";
|
|
853
|
+
readonly ifMatch: false;
|
|
854
|
+
readonly paged: false;
|
|
855
|
+
readonly status: 200;
|
|
856
|
+
readonly node: null;
|
|
857
|
+
readonly defaults: {};
|
|
858
|
+
};
|
|
859
|
+
readonly "project_keys.create": {
|
|
860
|
+
readonly method: "POST";
|
|
861
|
+
readonly path: "/v1/projects/{project_id}/keys";
|
|
862
|
+
readonly pathParams: readonly ["project_id"];
|
|
863
|
+
readonly scope: "keys:manage";
|
|
864
|
+
readonly kind: "write";
|
|
865
|
+
readonly sensitivity: "approval";
|
|
866
|
+
readonly idempotency: "required";
|
|
867
|
+
readonly ifMatch: false;
|
|
868
|
+
readonly paged: false;
|
|
869
|
+
readonly status: 201;
|
|
870
|
+
readonly node: null;
|
|
871
|
+
readonly defaults: {};
|
|
872
|
+
};
|
|
873
|
+
readonly "project_keys.revoke": {
|
|
874
|
+
readonly method: "DELETE";
|
|
875
|
+
readonly path: "/v1/keys/{key_id}";
|
|
876
|
+
readonly pathParams: readonly ["key_id"];
|
|
877
|
+
readonly scope: "keys:manage";
|
|
878
|
+
readonly kind: "write";
|
|
879
|
+
readonly sensitivity: "approval";
|
|
880
|
+
readonly idempotency: "none";
|
|
881
|
+
readonly ifMatch: false;
|
|
882
|
+
readonly paged: false;
|
|
883
|
+
readonly status: 200;
|
|
884
|
+
readonly node: null;
|
|
885
|
+
readonly defaults: {};
|
|
886
|
+
};
|
|
887
|
+
readonly "project_keys.rotate": {
|
|
888
|
+
readonly method: "POST";
|
|
889
|
+
readonly path: "/v1/keys/{key_id}/rotate";
|
|
890
|
+
readonly pathParams: readonly ["key_id"];
|
|
891
|
+
readonly scope: "keys:manage";
|
|
892
|
+
readonly kind: "write";
|
|
893
|
+
readonly sensitivity: "approval";
|
|
894
|
+
readonly idempotency: "optional";
|
|
895
|
+
readonly ifMatch: false;
|
|
896
|
+
readonly paged: false;
|
|
897
|
+
readonly status: 200;
|
|
898
|
+
readonly node: null;
|
|
899
|
+
readonly defaults: {};
|
|
900
|
+
};
|
|
901
|
+
readonly "projects.cancel_deletion": {
|
|
902
|
+
readonly method: "POST";
|
|
903
|
+
readonly path: "/v1/projects/{project_id}/restore";
|
|
904
|
+
readonly pathParams: readonly ["project_id"];
|
|
905
|
+
readonly scope: "projects:write";
|
|
906
|
+
readonly kind: "write";
|
|
907
|
+
readonly sensitivity: "normal";
|
|
908
|
+
readonly idempotency: "optional";
|
|
909
|
+
readonly ifMatch: false;
|
|
910
|
+
readonly paged: false;
|
|
911
|
+
readonly status: 200;
|
|
912
|
+
readonly node: null;
|
|
913
|
+
readonly defaults: {};
|
|
914
|
+
};
|
|
915
|
+
readonly "projects.create": {
|
|
916
|
+
readonly method: "POST";
|
|
917
|
+
readonly path: "/v1/projects";
|
|
918
|
+
readonly pathParams: readonly [];
|
|
919
|
+
readonly scope: "projects:write";
|
|
920
|
+
readonly kind: "write";
|
|
921
|
+
readonly sensitivity: "normal";
|
|
922
|
+
readonly idempotency: "required";
|
|
923
|
+
readonly ifMatch: false;
|
|
924
|
+
readonly paged: false;
|
|
925
|
+
readonly status: 201;
|
|
926
|
+
readonly node: null;
|
|
927
|
+
readonly defaults: {};
|
|
928
|
+
};
|
|
929
|
+
readonly "projects.get": {
|
|
930
|
+
readonly method: "GET";
|
|
931
|
+
readonly path: "/v1/projects/{project_id}";
|
|
932
|
+
readonly pathParams: readonly ["project_id"];
|
|
933
|
+
readonly scope: "projects:read";
|
|
934
|
+
readonly kind: "read";
|
|
935
|
+
readonly sensitivity: "normal";
|
|
936
|
+
readonly idempotency: "none";
|
|
937
|
+
readonly ifMatch: false;
|
|
938
|
+
readonly paged: false;
|
|
939
|
+
readonly status: 200;
|
|
940
|
+
readonly node: null;
|
|
941
|
+
readonly defaults: {};
|
|
942
|
+
};
|
|
943
|
+
readonly "projects.list": {
|
|
944
|
+
readonly method: "GET";
|
|
945
|
+
readonly path: "/v1/projects";
|
|
946
|
+
readonly pathParams: readonly [];
|
|
947
|
+
readonly scope: "projects:read";
|
|
948
|
+
readonly kind: "read";
|
|
949
|
+
readonly sensitivity: "normal";
|
|
950
|
+
readonly idempotency: "none";
|
|
951
|
+
readonly ifMatch: false;
|
|
952
|
+
readonly paged: true;
|
|
953
|
+
readonly status: 200;
|
|
954
|
+
readonly node: null;
|
|
955
|
+
readonly defaults: {};
|
|
956
|
+
};
|
|
957
|
+
readonly "projects.schedule_deletion": {
|
|
958
|
+
readonly method: "DELETE";
|
|
959
|
+
readonly path: "/v1/projects/{project_id}";
|
|
960
|
+
readonly pathParams: readonly ["project_id"];
|
|
961
|
+
readonly scope: "projects:delete";
|
|
962
|
+
readonly kind: "write";
|
|
963
|
+
readonly sensitivity: "approval";
|
|
964
|
+
readonly idempotency: "none";
|
|
965
|
+
readonly ifMatch: false;
|
|
966
|
+
readonly paged: false;
|
|
967
|
+
readonly status: 200;
|
|
968
|
+
readonly node: null;
|
|
969
|
+
readonly defaults: {};
|
|
970
|
+
};
|
|
971
|
+
readonly "projects.send_test_event": {
|
|
972
|
+
readonly method: "POST";
|
|
973
|
+
readonly path: "/v1/projects/{project_id}/test-event";
|
|
974
|
+
readonly pathParams: readonly ["project_id"];
|
|
975
|
+
readonly scope: "projects:write";
|
|
976
|
+
readonly kind: "write";
|
|
977
|
+
readonly sensitivity: "normal";
|
|
978
|
+
readonly idempotency: "optional";
|
|
979
|
+
readonly ifMatch: false;
|
|
980
|
+
readonly paged: false;
|
|
981
|
+
readonly status: 200;
|
|
982
|
+
readonly node: null;
|
|
983
|
+
readonly defaults: {};
|
|
984
|
+
};
|
|
985
|
+
readonly "projects.set_checkin_auth": {
|
|
986
|
+
readonly method: "PUT";
|
|
987
|
+
readonly path: "/v1/projects/{project_id}/checkin-auth";
|
|
988
|
+
readonly pathParams: readonly ["project_id"];
|
|
989
|
+
readonly scope: "keys:manage";
|
|
990
|
+
readonly kind: "write";
|
|
991
|
+
readonly sensitivity: "approval";
|
|
992
|
+
readonly idempotency: "none";
|
|
993
|
+
readonly ifMatch: false;
|
|
994
|
+
readonly paged: false;
|
|
995
|
+
readonly status: 200;
|
|
996
|
+
readonly node: null;
|
|
997
|
+
readonly defaults: {};
|
|
998
|
+
};
|
|
999
|
+
readonly "projects.set_environment_hidden": {
|
|
1000
|
+
readonly method: "PUT";
|
|
1001
|
+
readonly path: "/v1/projects/{project_id}/environments/{name}/hidden";
|
|
1002
|
+
readonly pathParams: readonly ["project_id", "name"];
|
|
1003
|
+
readonly scope: "projects:write";
|
|
1004
|
+
readonly kind: "write";
|
|
1005
|
+
readonly sensitivity: "normal";
|
|
1006
|
+
readonly idempotency: "none";
|
|
1007
|
+
readonly ifMatch: false;
|
|
1008
|
+
readonly paged: false;
|
|
1009
|
+
readonly status: 200;
|
|
1010
|
+
readonly node: null;
|
|
1011
|
+
readonly defaults: {};
|
|
1012
|
+
};
|
|
1013
|
+
readonly "projects.set_scrub": {
|
|
1014
|
+
readonly method: "PUT";
|
|
1015
|
+
readonly path: "/v1/projects/{project_id}/scrub/{group}";
|
|
1016
|
+
readonly pathParams: readonly ["project_id", "group"];
|
|
1017
|
+
readonly scope: "privacy:write";
|
|
1018
|
+
readonly kind: "write";
|
|
1019
|
+
readonly sensitivity: "normal";
|
|
1020
|
+
readonly idempotency: "none";
|
|
1021
|
+
readonly ifMatch: false;
|
|
1022
|
+
readonly paged: false;
|
|
1023
|
+
readonly status: 200;
|
|
1024
|
+
readonly node: null;
|
|
1025
|
+
readonly defaults: {};
|
|
1026
|
+
};
|
|
1027
|
+
readonly "projects.update": {
|
|
1028
|
+
readonly method: "PATCH";
|
|
1029
|
+
readonly path: "/v1/projects/{project_id}";
|
|
1030
|
+
readonly pathParams: readonly ["project_id"];
|
|
1031
|
+
readonly scope: "projects:write";
|
|
1032
|
+
readonly kind: "write";
|
|
1033
|
+
readonly sensitivity: "normal";
|
|
1034
|
+
readonly idempotency: "none";
|
|
1035
|
+
readonly ifMatch: true;
|
|
1036
|
+
readonly paged: false;
|
|
1037
|
+
readonly status: 200;
|
|
1038
|
+
readonly node: null;
|
|
1039
|
+
readonly defaults: {};
|
|
1040
|
+
};
|
|
1041
|
+
readonly "projects.update_intake": {
|
|
1042
|
+
readonly method: "PATCH";
|
|
1043
|
+
readonly path: "/v1/projects/{project_id}/intake";
|
|
1044
|
+
readonly pathParams: readonly ["project_id"];
|
|
1045
|
+
readonly scope: "projects:write";
|
|
1046
|
+
readonly kind: "write";
|
|
1047
|
+
readonly sensitivity: "normal";
|
|
1048
|
+
readonly idempotency: "none";
|
|
1049
|
+
readonly ifMatch: true;
|
|
1050
|
+
readonly paged: false;
|
|
1051
|
+
readonly status: 200;
|
|
1052
|
+
readonly node: null;
|
|
1053
|
+
readonly defaults: {};
|
|
1054
|
+
};
|
|
1055
|
+
readonly "projects.update_observability": {
|
|
1056
|
+
readonly method: "PATCH";
|
|
1057
|
+
readonly path: "/v1/projects/{project_id}/observability";
|
|
1058
|
+
readonly pathParams: readonly ["project_id"];
|
|
1059
|
+
readonly scope: "projects:write";
|
|
1060
|
+
readonly kind: "write";
|
|
1061
|
+
readonly sensitivity: "normal";
|
|
1062
|
+
readonly idempotency: "none";
|
|
1063
|
+
readonly ifMatch: true;
|
|
1064
|
+
readonly paged: false;
|
|
1065
|
+
readonly status: 200;
|
|
1066
|
+
readonly node: null;
|
|
1067
|
+
readonly defaults: {};
|
|
1068
|
+
};
|
|
1069
|
+
readonly "service_principals.create": {
|
|
1070
|
+
readonly method: "POST";
|
|
1071
|
+
readonly path: "/v1/service-accounts";
|
|
1072
|
+
readonly pathParams: readonly [];
|
|
1073
|
+
readonly scope: "tokens:manage";
|
|
1074
|
+
readonly kind: "write";
|
|
1075
|
+
readonly sensitivity: "approval";
|
|
1076
|
+
readonly idempotency: "required";
|
|
1077
|
+
readonly ifMatch: false;
|
|
1078
|
+
readonly paged: false;
|
|
1079
|
+
readonly status: 201;
|
|
1080
|
+
readonly node: null;
|
|
1081
|
+
readonly defaults: {};
|
|
1082
|
+
};
|
|
1083
|
+
readonly "service_principals.update": {
|
|
1084
|
+
readonly method: "PATCH";
|
|
1085
|
+
readonly path: "/v1/service-accounts/{id}";
|
|
1086
|
+
readonly pathParams: readonly ["id"];
|
|
1087
|
+
readonly scope: "tokens:manage";
|
|
1088
|
+
readonly kind: "write";
|
|
1089
|
+
readonly sensitivity: "approval";
|
|
1090
|
+
readonly idempotency: "none";
|
|
1091
|
+
readonly ifMatch: false;
|
|
1092
|
+
readonly paged: false;
|
|
1093
|
+
readonly status: 200;
|
|
1094
|
+
readonly node: null;
|
|
1095
|
+
readonly defaults: {};
|
|
1096
|
+
};
|
|
1097
|
+
readonly "slos.create": {
|
|
1098
|
+
readonly method: "POST";
|
|
1099
|
+
readonly path: "/v1/slos";
|
|
1100
|
+
readonly pathParams: readonly [];
|
|
1101
|
+
readonly scope: "monitors:write";
|
|
1102
|
+
readonly kind: "write";
|
|
1103
|
+
readonly sensitivity: "normal";
|
|
1104
|
+
readonly idempotency: "required";
|
|
1105
|
+
readonly ifMatch: false;
|
|
1106
|
+
readonly paged: false;
|
|
1107
|
+
readonly status: 201;
|
|
1108
|
+
readonly node: null;
|
|
1109
|
+
readonly defaults: {};
|
|
1110
|
+
};
|
|
1111
|
+
readonly "slos.delete": {
|
|
1112
|
+
readonly method: "DELETE";
|
|
1113
|
+
readonly path: "/v1/slos/{slo_id}";
|
|
1114
|
+
readonly pathParams: readonly ["slo_id"];
|
|
1115
|
+
readonly scope: "monitors:write";
|
|
1116
|
+
readonly kind: "write";
|
|
1117
|
+
readonly sensitivity: "normal";
|
|
1118
|
+
readonly idempotency: "none";
|
|
1119
|
+
readonly ifMatch: true;
|
|
1120
|
+
readonly paged: false;
|
|
1121
|
+
readonly status: 200;
|
|
1122
|
+
readonly node: null;
|
|
1123
|
+
readonly defaults: {};
|
|
1124
|
+
};
|
|
1125
|
+
readonly "slos.get": {
|
|
1126
|
+
readonly method: "GET";
|
|
1127
|
+
readonly path: "/v1/slos/{slo_id}";
|
|
1128
|
+
readonly pathParams: readonly ["slo_id"];
|
|
1129
|
+
readonly scope: "monitors:read";
|
|
1130
|
+
readonly kind: "read";
|
|
1131
|
+
readonly sensitivity: "normal";
|
|
1132
|
+
readonly idempotency: "none";
|
|
1133
|
+
readonly ifMatch: false;
|
|
1134
|
+
readonly paged: false;
|
|
1135
|
+
readonly status: 200;
|
|
1136
|
+
readonly node: null;
|
|
1137
|
+
readonly defaults: {};
|
|
1138
|
+
};
|
|
1139
|
+
readonly "slos.import": {
|
|
1140
|
+
readonly method: "POST";
|
|
1141
|
+
readonly path: "/v1/slos/import";
|
|
1142
|
+
readonly pathParams: readonly [];
|
|
1143
|
+
readonly scope: "monitors:write";
|
|
1144
|
+
readonly kind: "write";
|
|
1145
|
+
readonly sensitivity: "normal";
|
|
1146
|
+
readonly idempotency: "optional";
|
|
1147
|
+
readonly ifMatch: false;
|
|
1148
|
+
readonly paged: false;
|
|
1149
|
+
readonly status: 200;
|
|
1150
|
+
readonly node: null;
|
|
1151
|
+
readonly defaults: {};
|
|
1152
|
+
};
|
|
1153
|
+
readonly "slos.list": {
|
|
1154
|
+
readonly method: "GET";
|
|
1155
|
+
readonly path: "/v1/slos";
|
|
1156
|
+
readonly pathParams: readonly [];
|
|
1157
|
+
readonly scope: "monitors:read";
|
|
1158
|
+
readonly kind: "read";
|
|
1159
|
+
readonly sensitivity: "normal";
|
|
1160
|
+
readonly idempotency: "none";
|
|
1161
|
+
readonly ifMatch: false;
|
|
1162
|
+
readonly paged: true;
|
|
1163
|
+
readonly status: 200;
|
|
1164
|
+
readonly node: null;
|
|
1165
|
+
readonly defaults: {};
|
|
1166
|
+
};
|
|
1167
|
+
readonly "slos.set_hold": {
|
|
1168
|
+
readonly method: "PUT";
|
|
1169
|
+
readonly path: "/v1/slos/{slo_id}/hold";
|
|
1170
|
+
readonly pathParams: readonly ["slo_id"];
|
|
1171
|
+
readonly scope: "monitors:write";
|
|
1172
|
+
readonly kind: "write";
|
|
1173
|
+
readonly sensitivity: "normal";
|
|
1174
|
+
readonly idempotency: "none";
|
|
1175
|
+
readonly ifMatch: false;
|
|
1176
|
+
readonly paged: false;
|
|
1177
|
+
readonly status: 200;
|
|
1178
|
+
readonly node: null;
|
|
1179
|
+
readonly defaults: {};
|
|
1180
|
+
};
|
|
1181
|
+
readonly "slos.update": {
|
|
1182
|
+
readonly method: "PATCH";
|
|
1183
|
+
readonly path: "/v1/slos/{slo_id}";
|
|
1184
|
+
readonly pathParams: readonly ["slo_id"];
|
|
1185
|
+
readonly scope: "monitors:write";
|
|
1186
|
+
readonly kind: "write";
|
|
1187
|
+
readonly sensitivity: "normal";
|
|
1188
|
+
readonly idempotency: "none";
|
|
1189
|
+
readonly ifMatch: true;
|
|
1190
|
+
readonly paged: false;
|
|
1191
|
+
readonly status: 200;
|
|
1192
|
+
readonly node: null;
|
|
1193
|
+
readonly defaults: {};
|
|
1194
|
+
};
|
|
1195
|
+
readonly "spans.histogram": {
|
|
1196
|
+
readonly method: "GET";
|
|
1197
|
+
readonly path: "/v1/spans/histogram";
|
|
1198
|
+
readonly pathParams: readonly [];
|
|
1199
|
+
readonly scope: "traces:read";
|
|
1200
|
+
readonly kind: "node";
|
|
1201
|
+
readonly sensitivity: "normal";
|
|
1202
|
+
readonly idempotency: "none";
|
|
1203
|
+
readonly ifMatch: false;
|
|
1204
|
+
readonly paged: false;
|
|
1205
|
+
readonly status: 200;
|
|
1206
|
+
readonly node: {
|
|
1207
|
+
readonly path: "q/spans/histogram";
|
|
1208
|
+
readonly window: true;
|
|
1209
|
+
};
|
|
1210
|
+
readonly defaults: {};
|
|
1211
|
+
};
|
|
1212
|
+
readonly "spans.list": {
|
|
1213
|
+
readonly method: "GET";
|
|
1214
|
+
readonly path: "/v1/spans";
|
|
1215
|
+
readonly pathParams: readonly [];
|
|
1216
|
+
readonly scope: "traces:read";
|
|
1217
|
+
readonly kind: "node";
|
|
1218
|
+
readonly sensitivity: "normal";
|
|
1219
|
+
readonly idempotency: "none";
|
|
1220
|
+
readonly ifMatch: false;
|
|
1221
|
+
readonly paged: true;
|
|
1222
|
+
readonly status: 200;
|
|
1223
|
+
readonly node: {
|
|
1224
|
+
readonly path: "q/spans";
|
|
1225
|
+
readonly list: "spans";
|
|
1226
|
+
readonly window: true;
|
|
1227
|
+
};
|
|
1228
|
+
readonly defaults: {};
|
|
1229
|
+
};
|
|
1230
|
+
readonly "telemetry.usage": {
|
|
1231
|
+
readonly method: "GET";
|
|
1232
|
+
readonly path: "/v1/telemetry/usage";
|
|
1233
|
+
readonly pathParams: readonly [];
|
|
1234
|
+
readonly scope: "usage:read";
|
|
1235
|
+
readonly kind: "node";
|
|
1236
|
+
readonly sensitivity: "normal";
|
|
1237
|
+
readonly idempotency: "none";
|
|
1238
|
+
readonly ifMatch: false;
|
|
1239
|
+
readonly paged: false;
|
|
1240
|
+
readonly status: 200;
|
|
1241
|
+
readonly node: {
|
|
1242
|
+
readonly path: "q/telemetry/usage";
|
|
1243
|
+
};
|
|
1244
|
+
readonly defaults: {};
|
|
1245
|
+
};
|
|
1246
|
+
readonly "tickets.create": {
|
|
1247
|
+
readonly method: "POST";
|
|
1248
|
+
readonly path: "/v1/tickets";
|
|
1249
|
+
readonly pathParams: readonly [];
|
|
1250
|
+
readonly scope: "issues:read";
|
|
1251
|
+
readonly kind: "node";
|
|
1252
|
+
readonly sensitivity: "normal";
|
|
1253
|
+
readonly idempotency: "none";
|
|
1254
|
+
readonly ifMatch: false;
|
|
1255
|
+
readonly paged: false;
|
|
1256
|
+
readonly status: 201;
|
|
1257
|
+
readonly node: {
|
|
1258
|
+
readonly path: "";
|
|
1259
|
+
};
|
|
1260
|
+
readonly defaults: {};
|
|
1261
|
+
};
|
|
1262
|
+
readonly "tokens.create_personal": {
|
|
1263
|
+
readonly method: "POST";
|
|
1264
|
+
readonly path: "/v1/tokens";
|
|
1265
|
+
readonly pathParams: readonly [];
|
|
1266
|
+
readonly scope: "tokens:manage";
|
|
1267
|
+
readonly kind: "write";
|
|
1268
|
+
readonly sensitivity: "approval";
|
|
1269
|
+
readonly idempotency: "required";
|
|
1270
|
+
readonly ifMatch: false;
|
|
1271
|
+
readonly paged: false;
|
|
1272
|
+
readonly status: 201;
|
|
1273
|
+
readonly node: null;
|
|
1274
|
+
readonly defaults: {};
|
|
1275
|
+
};
|
|
1276
|
+
readonly "tokens.create_service": {
|
|
1277
|
+
readonly method: "POST";
|
|
1278
|
+
readonly path: "/v1/service-accounts/{service_principal_id}/tokens";
|
|
1279
|
+
readonly pathParams: readonly ["service_principal_id"];
|
|
1280
|
+
readonly scope: "tokens:manage";
|
|
1281
|
+
readonly kind: "write";
|
|
1282
|
+
readonly sensitivity: "approval";
|
|
1283
|
+
readonly idempotency: "required";
|
|
1284
|
+
readonly ifMatch: false;
|
|
1285
|
+
readonly paged: false;
|
|
1286
|
+
readonly status: 201;
|
|
1287
|
+
readonly node: null;
|
|
1288
|
+
readonly defaults: {};
|
|
1289
|
+
};
|
|
1290
|
+
readonly "tokens.revoke": {
|
|
1291
|
+
readonly method: "DELETE";
|
|
1292
|
+
readonly path: "/v1/tokens/{id}";
|
|
1293
|
+
readonly pathParams: readonly ["id"];
|
|
1294
|
+
readonly scope: "tokens:manage";
|
|
1295
|
+
readonly kind: "write";
|
|
1296
|
+
readonly sensitivity: "normal";
|
|
1297
|
+
readonly idempotency: "none";
|
|
1298
|
+
readonly ifMatch: false;
|
|
1299
|
+
readonly paged: false;
|
|
1300
|
+
readonly status: 200;
|
|
1301
|
+
readonly node: null;
|
|
1302
|
+
readonly defaults: {};
|
|
1303
|
+
};
|
|
1304
|
+
readonly "tokens.set_policy": {
|
|
1305
|
+
readonly method: "PUT";
|
|
1306
|
+
readonly path: "/v1/token-policy";
|
|
1307
|
+
readonly pathParams: readonly [];
|
|
1308
|
+
readonly scope: "tokens:manage";
|
|
1309
|
+
readonly kind: "write";
|
|
1310
|
+
readonly sensitivity: "approval";
|
|
1311
|
+
readonly idempotency: "none";
|
|
1312
|
+
readonly ifMatch: false;
|
|
1313
|
+
readonly paged: false;
|
|
1314
|
+
readonly status: 200;
|
|
1315
|
+
readonly node: null;
|
|
1316
|
+
readonly defaults: {};
|
|
1317
|
+
};
|
|
1318
|
+
readonly "traces.get": {
|
|
1319
|
+
readonly method: "GET";
|
|
1320
|
+
readonly path: "/v1/traces/{trace_id}";
|
|
1321
|
+
readonly pathParams: readonly ["trace_id"];
|
|
1322
|
+
readonly scope: "traces:read";
|
|
1323
|
+
readonly kind: "node";
|
|
1324
|
+
readonly sensitivity: "normal";
|
|
1325
|
+
readonly idempotency: "none";
|
|
1326
|
+
readonly ifMatch: false;
|
|
1327
|
+
readonly paged: false;
|
|
1328
|
+
readonly status: 200;
|
|
1329
|
+
readonly node: {
|
|
1330
|
+
readonly path: "q/traces/{trace_id}/summary";
|
|
1331
|
+
};
|
|
1332
|
+
readonly defaults: {};
|
|
1333
|
+
};
|
|
1334
|
+
readonly "traces.span": {
|
|
1335
|
+
readonly method: "GET";
|
|
1336
|
+
readonly path: "/v1/traces/{trace_id}/spans/{span_id}";
|
|
1337
|
+
readonly pathParams: readonly ["trace_id", "span_id"];
|
|
1338
|
+
readonly scope: "traces:read";
|
|
1339
|
+
readonly kind: "node";
|
|
1340
|
+
readonly sensitivity: "normal";
|
|
1341
|
+
readonly idempotency: "none";
|
|
1342
|
+
readonly ifMatch: false;
|
|
1343
|
+
readonly paged: false;
|
|
1344
|
+
readonly status: 200;
|
|
1345
|
+
readonly node: {
|
|
1346
|
+
readonly path: "q/spans/{trace_id}/{span_id}";
|
|
1347
|
+
};
|
|
1348
|
+
readonly defaults: {};
|
|
1349
|
+
};
|
|
1350
|
+
readonly "traces.spans": {
|
|
1351
|
+
readonly method: "GET";
|
|
1352
|
+
readonly path: "/v1/traces/{trace_id}/spans";
|
|
1353
|
+
readonly pathParams: readonly ["trace_id"];
|
|
1354
|
+
readonly scope: "traces:read";
|
|
1355
|
+
readonly kind: "node";
|
|
1356
|
+
readonly sensitivity: "normal";
|
|
1357
|
+
readonly idempotency: "none";
|
|
1358
|
+
readonly ifMatch: false;
|
|
1359
|
+
readonly paged: false;
|
|
1360
|
+
readonly status: 200;
|
|
1361
|
+
readonly node: {
|
|
1362
|
+
readonly path: "q/traces/{trace_id}/spans";
|
|
1363
|
+
};
|
|
1364
|
+
readonly defaults: {};
|
|
1365
|
+
};
|
|
1366
|
+
readonly "upload_tokens.create": {
|
|
1367
|
+
readonly method: "POST";
|
|
1368
|
+
readonly path: "/v1/projects/{project_id}/upload-tokens";
|
|
1369
|
+
readonly pathParams: readonly ["project_id"];
|
|
1370
|
+
readonly scope: "keys:manage";
|
|
1371
|
+
readonly kind: "write";
|
|
1372
|
+
readonly sensitivity: "approval";
|
|
1373
|
+
readonly idempotency: "required";
|
|
1374
|
+
readonly ifMatch: false;
|
|
1375
|
+
readonly paged: false;
|
|
1376
|
+
readonly status: 201;
|
|
1377
|
+
readonly node: null;
|
|
1378
|
+
readonly defaults: {};
|
|
1379
|
+
};
|
|
1380
|
+
readonly "upload_tokens.revoke": {
|
|
1381
|
+
readonly method: "DELETE";
|
|
1382
|
+
readonly path: "/v1/upload-tokens/{token_id}";
|
|
1383
|
+
readonly pathParams: readonly ["token_id"];
|
|
1384
|
+
readonly scope: "keys:manage";
|
|
1385
|
+
readonly kind: "write";
|
|
1386
|
+
readonly sensitivity: "approval";
|
|
1387
|
+
readonly idempotency: "none";
|
|
1388
|
+
readonly ifMatch: false;
|
|
1389
|
+
readonly paged: false;
|
|
1390
|
+
readonly status: 200;
|
|
1391
|
+
readonly node: null;
|
|
1392
|
+
readonly defaults: {};
|
|
1393
|
+
};
|
|
1394
|
+
readonly "uptime.create": {
|
|
1395
|
+
readonly method: "POST";
|
|
1396
|
+
readonly path: "/v1/uptime-checks";
|
|
1397
|
+
readonly pathParams: readonly [];
|
|
1398
|
+
readonly scope: "monitors:write";
|
|
1399
|
+
readonly kind: "write";
|
|
1400
|
+
readonly sensitivity: "normal";
|
|
1401
|
+
readonly idempotency: "required";
|
|
1402
|
+
readonly ifMatch: false;
|
|
1403
|
+
readonly paged: false;
|
|
1404
|
+
readonly status: 201;
|
|
1405
|
+
readonly node: null;
|
|
1406
|
+
readonly defaults: {};
|
|
1407
|
+
};
|
|
1408
|
+
readonly "uptime.delete": {
|
|
1409
|
+
readonly method: "DELETE";
|
|
1410
|
+
readonly path: "/v1/uptime-checks/{check_id}";
|
|
1411
|
+
readonly pathParams: readonly ["check_id"];
|
|
1412
|
+
readonly scope: "monitors:write";
|
|
1413
|
+
readonly kind: "write";
|
|
1414
|
+
readonly sensitivity: "normal";
|
|
1415
|
+
readonly idempotency: "none";
|
|
1416
|
+
readonly ifMatch: true;
|
|
1417
|
+
readonly paged: false;
|
|
1418
|
+
readonly status: 200;
|
|
1419
|
+
readonly node: null;
|
|
1420
|
+
readonly defaults: {};
|
|
1421
|
+
};
|
|
1422
|
+
readonly "uptime.get": {
|
|
1423
|
+
readonly method: "GET";
|
|
1424
|
+
readonly path: "/v1/uptime-checks/{check_id}";
|
|
1425
|
+
readonly pathParams: readonly ["check_id"];
|
|
1426
|
+
readonly scope: "monitors:read";
|
|
1427
|
+
readonly kind: "read";
|
|
1428
|
+
readonly sensitivity: "normal";
|
|
1429
|
+
readonly idempotency: "none";
|
|
1430
|
+
readonly ifMatch: false;
|
|
1431
|
+
readonly paged: false;
|
|
1432
|
+
readonly status: 200;
|
|
1433
|
+
readonly node: null;
|
|
1434
|
+
readonly defaults: {};
|
|
1435
|
+
};
|
|
1436
|
+
readonly "uptime.list": {
|
|
1437
|
+
readonly method: "GET";
|
|
1438
|
+
readonly path: "/v1/uptime-checks";
|
|
1439
|
+
readonly pathParams: readonly [];
|
|
1440
|
+
readonly scope: "monitors:read";
|
|
1441
|
+
readonly kind: "read";
|
|
1442
|
+
readonly sensitivity: "normal";
|
|
1443
|
+
readonly idempotency: "none";
|
|
1444
|
+
readonly ifMatch: false;
|
|
1445
|
+
readonly paged: true;
|
|
1446
|
+
readonly status: 200;
|
|
1447
|
+
readonly node: null;
|
|
1448
|
+
readonly defaults: {};
|
|
1449
|
+
};
|
|
1450
|
+
readonly "uptime.run_now": {
|
|
1451
|
+
readonly method: "POST";
|
|
1452
|
+
readonly path: "/v1/uptime-checks/{check_id}/runs";
|
|
1453
|
+
readonly pathParams: readonly ["check_id"];
|
|
1454
|
+
readonly scope: "monitors:write";
|
|
1455
|
+
readonly kind: "write";
|
|
1456
|
+
readonly sensitivity: "normal";
|
|
1457
|
+
readonly idempotency: "optional";
|
|
1458
|
+
readonly ifMatch: false;
|
|
1459
|
+
readonly paged: false;
|
|
1460
|
+
readonly status: 201;
|
|
1461
|
+
readonly node: null;
|
|
1462
|
+
readonly defaults: {};
|
|
1463
|
+
};
|
|
1464
|
+
readonly "uptime.set_hold": {
|
|
1465
|
+
readonly method: "PUT";
|
|
1466
|
+
readonly path: "/v1/uptime-checks/{check_id}/hold";
|
|
1467
|
+
readonly pathParams: readonly ["check_id"];
|
|
1468
|
+
readonly scope: "monitors:write";
|
|
1469
|
+
readonly kind: "write";
|
|
1470
|
+
readonly sensitivity: "normal";
|
|
1471
|
+
readonly idempotency: "none";
|
|
1472
|
+
readonly ifMatch: false;
|
|
1473
|
+
readonly paged: false;
|
|
1474
|
+
readonly status: 200;
|
|
1475
|
+
readonly node: null;
|
|
1476
|
+
readonly defaults: {};
|
|
1477
|
+
};
|
|
1478
|
+
readonly "uptime.update": {
|
|
1479
|
+
readonly method: "PATCH";
|
|
1480
|
+
readonly path: "/v1/uptime-checks/{check_id}";
|
|
1481
|
+
readonly pathParams: readonly ["check_id"];
|
|
1482
|
+
readonly scope: "monitors:write";
|
|
1483
|
+
readonly kind: "write";
|
|
1484
|
+
readonly sensitivity: "normal";
|
|
1485
|
+
readonly idempotency: "none";
|
|
1486
|
+
readonly ifMatch: true;
|
|
1487
|
+
readonly paged: false;
|
|
1488
|
+
readonly status: 200;
|
|
1489
|
+
readonly node: null;
|
|
1490
|
+
readonly defaults: {};
|
|
1491
|
+
};
|
|
1492
|
+
readonly "usage.get": {
|
|
1493
|
+
readonly method: "GET";
|
|
1494
|
+
readonly path: "/v1/usage";
|
|
1495
|
+
readonly pathParams: readonly [];
|
|
1496
|
+
readonly scope: "usage:read";
|
|
1497
|
+
readonly kind: "read";
|
|
1498
|
+
readonly sensitivity: "normal";
|
|
1499
|
+
readonly idempotency: "none";
|
|
1500
|
+
readonly ifMatch: false;
|
|
1501
|
+
readonly paged: false;
|
|
1502
|
+
readonly status: 200;
|
|
1503
|
+
readonly node: null;
|
|
1504
|
+
readonly defaults: {};
|
|
1505
|
+
};
|
|
1506
|
+
readonly "workspace.get": {
|
|
1507
|
+
readonly method: "GET";
|
|
1508
|
+
readonly path: "/v1/workspace";
|
|
1509
|
+
readonly pathParams: readonly [];
|
|
1510
|
+
readonly scope: "org:read";
|
|
1511
|
+
readonly kind: "read";
|
|
1512
|
+
readonly sensitivity: "normal";
|
|
1513
|
+
readonly idempotency: "none";
|
|
1514
|
+
readonly ifMatch: false;
|
|
1515
|
+
readonly paged: false;
|
|
1516
|
+
readonly status: 200;
|
|
1517
|
+
readonly node: null;
|
|
1518
|
+
readonly defaults: {};
|
|
1519
|
+
};
|
|
1520
|
+
};
|
|
1521
|
+
/** Parameters of every operation in REST wire names: path values, then query (GET) or body fields. */
|
|
1522
|
+
export interface OperationParams {
|
|
1523
|
+
/** Send a failed delivery from the last 7 days once more. */
|
|
1524
|
+
"alert_deliveries.replay": {
|
|
1525
|
+
delivery_id: string;
|
|
1526
|
+
};
|
|
1527
|
+
/** Delete a rule. */
|
|
1528
|
+
"alert_rules.delete": {
|
|
1529
|
+
rule_id: string;
|
|
1530
|
+
};
|
|
1531
|
+
/** Alert rules. */
|
|
1532
|
+
"alert_rules.list": {
|
|
1533
|
+
limit?: number;
|
|
1534
|
+
cursor?: string;
|
|
1535
|
+
};
|
|
1536
|
+
/** Create a rule (`rule_id` null) or replace one: triggers, level, environments, destinations. */
|
|
1537
|
+
"alert_rules.save": {
|
|
1538
|
+
rule_id: string | null;
|
|
1539
|
+
name: string;
|
|
1540
|
+
project_id: number | null;
|
|
1541
|
+
triggers: Array<"new_issue" | "regression" | "escalating" | "integration_problem" | "monitor_problem" | "uptime_problem" | "slo_burn">;
|
|
1542
|
+
min_level: "warning" | "error" | "fatal";
|
|
1543
|
+
environments: Array<string>;
|
|
1544
|
+
throttle_minutes: number;
|
|
1545
|
+
is_enabled: boolean;
|
|
1546
|
+
notify_all: boolean;
|
|
1547
|
+
destination_ids: Array<string>;
|
|
1548
|
+
monitor_kinds?: Array<"missed" | "failed" | "timeout" | "unknown">;
|
|
1549
|
+
slo_severities?: Array<"page" | "ticket">;
|
|
1550
|
+
};
|
|
1551
|
+
/** Turn a rule on or off. */
|
|
1552
|
+
"alert_rules.set_enabled": {
|
|
1553
|
+
rule_id: string;
|
|
1554
|
+
enabled: boolean;
|
|
1555
|
+
};
|
|
1556
|
+
/** Alerts: one row per violation episode of a monitor, open or resolved. */
|
|
1557
|
+
"alerts.list": {
|
|
1558
|
+
limit?: number;
|
|
1559
|
+
cursor?: string;
|
|
1560
|
+
state?: "open" | "resolved" | "all";
|
|
1561
|
+
monitor_id?: string;
|
|
1562
|
+
};
|
|
1563
|
+
/** Audit log, newest first (admins). */
|
|
1564
|
+
"audit.list": {
|
|
1565
|
+
limit?: number;
|
|
1566
|
+
cursor?: string;
|
|
1567
|
+
};
|
|
1568
|
+
/** Start adding a Telegram, Slack, email or webhook destination; a person enters its secrets. */
|
|
1569
|
+
"destinations.create": {
|
|
1570
|
+
provider: "telegram" | "slack" | "email" | "webhook";
|
|
1571
|
+
name: string;
|
|
1572
|
+
project_ids: Array<number>;
|
|
1573
|
+
locale: "vi" | "en";
|
|
1574
|
+
};
|
|
1575
|
+
/** Delete a destination. */
|
|
1576
|
+
"destinations.delete": {
|
|
1577
|
+
destination_id: string;
|
|
1578
|
+
};
|
|
1579
|
+
/** Alert destinations with a masked hint; secrets never leave the server. */
|
|
1580
|
+
"destinations.list": {
|
|
1581
|
+
limit?: number;
|
|
1582
|
+
cursor?: string;
|
|
1583
|
+
};
|
|
1584
|
+
/** Send the confirmation email to a recipient again. */
|
|
1585
|
+
"destinations.resend_confirmation": {
|
|
1586
|
+
recipient_id: string;
|
|
1587
|
+
};
|
|
1588
|
+
/** Queue a [TEST] message to the destination. */
|
|
1589
|
+
"destinations.send_test": {
|
|
1590
|
+
destination_id: string;
|
|
1591
|
+
};
|
|
1592
|
+
/** Set an email destination's recipients (new ones confirm). */
|
|
1593
|
+
"destinations.set_recipients": {
|
|
1594
|
+
destination_id: string;
|
|
1595
|
+
emails: Array<string>;
|
|
1596
|
+
};
|
|
1597
|
+
/** Rename a destination or change its projects. */
|
|
1598
|
+
"destinations.update": {
|
|
1599
|
+
destination_id: string;
|
|
1600
|
+
name: string;
|
|
1601
|
+
project_ids: Array<number>;
|
|
1602
|
+
};
|
|
1603
|
+
/** Replace a destination's token, password or signing secret (entered by a person). */
|
|
1604
|
+
"destinations.update_connection": {
|
|
1605
|
+
destination_id: string;
|
|
1606
|
+
};
|
|
1607
|
+
/** One event (or `latest`/`oldest`), scrubbed again on the node, with its neighbours. */
|
|
1608
|
+
"events.get": {
|
|
1609
|
+
issue_id: number;
|
|
1610
|
+
event_id: string;
|
|
1611
|
+
};
|
|
1612
|
+
/** Events of one issue, newest first. */
|
|
1613
|
+
"events.list": {
|
|
1614
|
+
issue_id: number;
|
|
1615
|
+
cursor?: string;
|
|
1616
|
+
};
|
|
1617
|
+
/** Create an OTLP ingest key (`bvi_`). */
|
|
1618
|
+
"ingest_keys.create": {
|
|
1619
|
+
project_id: number;
|
|
1620
|
+
name: string;
|
|
1621
|
+
scopes: Array<"traces" | "logs" | "errors" | "monitors">;
|
|
1622
|
+
environments: Array<string>;
|
|
1623
|
+
expires_at: string | null;
|
|
1624
|
+
};
|
|
1625
|
+
/** Revoke an OTLP ingest key. */
|
|
1626
|
+
"ingest_keys.revoke": {
|
|
1627
|
+
key_id: string;
|
|
1628
|
+
};
|
|
1629
|
+
/** Invite someone by email. */
|
|
1630
|
+
"invites.create": {
|
|
1631
|
+
email: string;
|
|
1632
|
+
role: "admin" | "member" | "viewer";
|
|
1633
|
+
locale: "vi" | "en";
|
|
1634
|
+
};
|
|
1635
|
+
/** Withdraw an open invite. */
|
|
1636
|
+
"invites.revoke": {
|
|
1637
|
+
invite_id: string;
|
|
1638
|
+
};
|
|
1639
|
+
/** Status changes, assignments and regressions of one issue. */
|
|
1640
|
+
"issues.activity": {
|
|
1641
|
+
issue_id: number;
|
|
1642
|
+
};
|
|
1643
|
+
/** The same change for up to 100 issues at once. */
|
|
1644
|
+
"issues.bulk_update": {
|
|
1645
|
+
issue_ids: Array<number>;
|
|
1646
|
+
action: {
|
|
1647
|
+
action: "resolve";
|
|
1648
|
+
in_next_release?: boolean;
|
|
1649
|
+
} | {
|
|
1650
|
+
action: "unresolve";
|
|
1651
|
+
} | {
|
|
1652
|
+
action: "archive";
|
|
1653
|
+
mode: "until_escalating" | "forever";
|
|
1654
|
+
} | {
|
|
1655
|
+
action: "archive";
|
|
1656
|
+
mode: "until_condition";
|
|
1657
|
+
events?: number;
|
|
1658
|
+
users?: number;
|
|
1659
|
+
until?: string;
|
|
1660
|
+
} | {
|
|
1661
|
+
action: "assign";
|
|
1662
|
+
user_id: string | null;
|
|
1663
|
+
} | {
|
|
1664
|
+
action: "priority";
|
|
1665
|
+
priority: "low" | "medium" | "high";
|
|
1666
|
+
};
|
|
1667
|
+
};
|
|
1668
|
+
/** One issue with its 24 h and 30 d counts. */
|
|
1669
|
+
"issues.get": {
|
|
1670
|
+
issue_id: number;
|
|
1671
|
+
};
|
|
1672
|
+
/** Issues of the token's projects, filtered and sorted like the Issues page. */
|
|
1673
|
+
"issues.list": {
|
|
1674
|
+
project?: string;
|
|
1675
|
+
status?: "unresolved" | "resolved" | "archived" | "all";
|
|
1676
|
+
level?: string;
|
|
1677
|
+
priority?: string;
|
|
1678
|
+
environment?: string;
|
|
1679
|
+
release?: string;
|
|
1680
|
+
assignee?: string;
|
|
1681
|
+
period?: "1h" | "24h" | "7d" | "14d" | "30d";
|
|
1682
|
+
q?: string;
|
|
1683
|
+
sort?: "last_seen" | "first_seen" | "events" | "users" | "priority";
|
|
1684
|
+
cursor?: string;
|
|
1685
|
+
limit?: number;
|
|
1686
|
+
};
|
|
1687
|
+
/** Event counts of one issue over time (24 h or 30 d). */
|
|
1688
|
+
"issues.stats": {
|
|
1689
|
+
issue_id: number;
|
|
1690
|
+
range?: "24h" | "30d";
|
|
1691
|
+
};
|
|
1692
|
+
/** Top values of environment, release, platform and SDK for one issue. */
|
|
1693
|
+
"issues.tags": {
|
|
1694
|
+
issue_id: number;
|
|
1695
|
+
};
|
|
1696
|
+
/** Resolve, unresolve, archive, assign or set the priority of one issue (idempotent by state). */
|
|
1697
|
+
"issues.update": {
|
|
1698
|
+
issue_id: number;
|
|
1699
|
+
} & ((Record<string, unknown>) & ({
|
|
1700
|
+
action: "resolve";
|
|
1701
|
+
in_next_release?: boolean;
|
|
1702
|
+
} | {
|
|
1703
|
+
action: "unresolve";
|
|
1704
|
+
} | {
|
|
1705
|
+
action: "archive";
|
|
1706
|
+
mode: "until_escalating" | "forever";
|
|
1707
|
+
} | {
|
|
1708
|
+
action: "archive";
|
|
1709
|
+
mode: "until_condition";
|
|
1710
|
+
events?: number;
|
|
1711
|
+
users?: number;
|
|
1712
|
+
until?: string;
|
|
1713
|
+
} | {
|
|
1714
|
+
action: "assign";
|
|
1715
|
+
user_id: string | null;
|
|
1716
|
+
} | {
|
|
1717
|
+
action: "priority";
|
|
1718
|
+
priority: "low" | "medium" | "high";
|
|
1719
|
+
}));
|
|
1720
|
+
/** Log records just before and after one record. */
|
|
1721
|
+
"logs.around": {
|
|
1722
|
+
log_id: string;
|
|
1723
|
+
at: string;
|
|
1724
|
+
same?: "service" | "trace";
|
|
1725
|
+
before?: number;
|
|
1726
|
+
after?: number;
|
|
1727
|
+
};
|
|
1728
|
+
/** Top services, environments and severities of the matching logs. */
|
|
1729
|
+
"logs.facets": {
|
|
1730
|
+
start?: string;
|
|
1731
|
+
end?: string;
|
|
1732
|
+
project?: string;
|
|
1733
|
+
environment?: string;
|
|
1734
|
+
service?: string;
|
|
1735
|
+
attrs?: string;
|
|
1736
|
+
severity_min?: "trace" | "debug" | "info" | "warn" | "error" | "fatal";
|
|
1737
|
+
q?: string;
|
|
1738
|
+
};
|
|
1739
|
+
/** Log counts by severity over a window. */
|
|
1740
|
+
"logs.histogram": {
|
|
1741
|
+
start?: string;
|
|
1742
|
+
end?: string;
|
|
1743
|
+
project?: string;
|
|
1744
|
+
environment?: string;
|
|
1745
|
+
service?: string;
|
|
1746
|
+
attrs?: string;
|
|
1747
|
+
severity_min?: "trace" | "debug" | "info" | "warn" | "error" | "fatal";
|
|
1748
|
+
q?: string;
|
|
1749
|
+
};
|
|
1750
|
+
/** Log records in a window of at most 7 days, with text and attribute filters. */
|
|
1751
|
+
"logs.list": {
|
|
1752
|
+
start?: string;
|
|
1753
|
+
end?: string;
|
|
1754
|
+
project?: string;
|
|
1755
|
+
environment?: string;
|
|
1756
|
+
service?: string;
|
|
1757
|
+
attrs?: string;
|
|
1758
|
+
severity_min?: "trace" | "debug" | "info" | "warn" | "error" | "fatal";
|
|
1759
|
+
trace_id?: string;
|
|
1760
|
+
span_id?: string;
|
|
1761
|
+
q?: string;
|
|
1762
|
+
order?: "asc" | "desc";
|
|
1763
|
+
cursor?: string;
|
|
1764
|
+
};
|
|
1765
|
+
/** Change a member's role. */
|
|
1766
|
+
"members.change_role": {
|
|
1767
|
+
user_id: string;
|
|
1768
|
+
role: "owner" | "admin" | "member" | "viewer";
|
|
1769
|
+
};
|
|
1770
|
+
/** Workspace members and their roles. */
|
|
1771
|
+
"members.list": {
|
|
1772
|
+
limit?: number;
|
|
1773
|
+
cursor?: string;
|
|
1774
|
+
};
|
|
1775
|
+
/** Remove a member; their tokens stop working. */
|
|
1776
|
+
"members.remove": {
|
|
1777
|
+
user_id: string;
|
|
1778
|
+
};
|
|
1779
|
+
/** Create a cron or heartbeat monitor. A heartbeat monitor returns its ping token once. */
|
|
1780
|
+
"monitors.create": {
|
|
1781
|
+
project_id: number;
|
|
1782
|
+
slug: string;
|
|
1783
|
+
name: string;
|
|
1784
|
+
mode?: "check_in" | "heartbeat";
|
|
1785
|
+
kind: "crontab" | "interval" | "on_demand";
|
|
1786
|
+
schedule: {
|
|
1787
|
+
type: "crontab";
|
|
1788
|
+
value: string;
|
|
1789
|
+
} | {
|
|
1790
|
+
type: "interval";
|
|
1791
|
+
value: number;
|
|
1792
|
+
unit: "minute" | "hour" | "day" | "week" | "month" | "year";
|
|
1793
|
+
} | null;
|
|
1794
|
+
timezone: string;
|
|
1795
|
+
checkin_margin_min: number;
|
|
1796
|
+
max_runtime_min: number;
|
|
1797
|
+
failure_threshold: number;
|
|
1798
|
+
recovery_threshold: number;
|
|
1799
|
+
expected_environments: Array<string>;
|
|
1800
|
+
};
|
|
1801
|
+
/** Delete a monitor; `confirm_slug` must repeat its slug. */
|
|
1802
|
+
"monitors.delete": {
|
|
1803
|
+
monitor_id: string;
|
|
1804
|
+
confirm_slug: string;
|
|
1805
|
+
};
|
|
1806
|
+
/** Dismiss a monitor slug seen in check-ins but not configured. */
|
|
1807
|
+
"monitors.dismiss_discovery": {
|
|
1808
|
+
discovery_id: string;
|
|
1809
|
+
};
|
|
1810
|
+
/** One monitor with its ETag. */
|
|
1811
|
+
"monitors.get": {
|
|
1812
|
+
monitor_id: string;
|
|
1813
|
+
};
|
|
1814
|
+
/** Cron and heartbeat monitors. */
|
|
1815
|
+
"monitors.list": {
|
|
1816
|
+
limit?: number;
|
|
1817
|
+
cursor?: string;
|
|
1818
|
+
project_id?: number;
|
|
1819
|
+
};
|
|
1820
|
+
/** Mute or unmute a monitor's alerts. */
|
|
1821
|
+
"monitors.set_muted": {
|
|
1822
|
+
monitor_id: string;
|
|
1823
|
+
muted: boolean;
|
|
1824
|
+
};
|
|
1825
|
+
/** Pause until a time, `forever`, or resume with null. */
|
|
1826
|
+
"monitors.set_pause": {
|
|
1827
|
+
monitor_id: string;
|
|
1828
|
+
until: string | "forever" | null;
|
|
1829
|
+
};
|
|
1830
|
+
/** Replace a monitor's schedule, margins and thresholds. */
|
|
1831
|
+
"monitors.update": {
|
|
1832
|
+
monitor_id: string;
|
|
1833
|
+
name: string;
|
|
1834
|
+
mode?: "check_in" | "heartbeat";
|
|
1835
|
+
kind: "crontab" | "interval" | "on_demand";
|
|
1836
|
+
schedule: {
|
|
1837
|
+
type: "crontab";
|
|
1838
|
+
value: string;
|
|
1839
|
+
} | {
|
|
1840
|
+
type: "interval";
|
|
1841
|
+
value: number;
|
|
1842
|
+
unit: "minute" | "hour" | "day" | "week" | "month" | "year";
|
|
1843
|
+
} | null;
|
|
1844
|
+
timezone: string;
|
|
1845
|
+
checkin_margin_min: number;
|
|
1846
|
+
max_runtime_min: number;
|
|
1847
|
+
failure_threshold: number;
|
|
1848
|
+
recovery_threshold: number;
|
|
1849
|
+
expected_environments: Array<string>;
|
|
1850
|
+
};
|
|
1851
|
+
/** Start a backup now (at most once per 10 minutes). */
|
|
1852
|
+
"node.backup_now": Record<string, never>;
|
|
1853
|
+
/** Cancel a scheduled node deletion. */
|
|
1854
|
+
"node.cancel_deletion": {
|
|
1855
|
+
node_id: string;
|
|
1856
|
+
};
|
|
1857
|
+
/** The node's state, versions and last heartbeat (null before provisioning). */
|
|
1858
|
+
"node.get": Record<string, never>;
|
|
1859
|
+
/** Create the workspace's node in its Hetzner project. */
|
|
1860
|
+
"node.provision": Record<string, never>;
|
|
1861
|
+
/** Rebuild the node from its latest backup. */
|
|
1862
|
+
"node.rebuild": {
|
|
1863
|
+
node_id: string;
|
|
1864
|
+
confirm_name: string;
|
|
1865
|
+
};
|
|
1866
|
+
/** Move the node to another server type. */
|
|
1867
|
+
"node.resize": {
|
|
1868
|
+
node_id: string;
|
|
1869
|
+
server_type: "cx23" | "cx33" | "cx43" | "cax11" | "cax21";
|
|
1870
|
+
};
|
|
1871
|
+
/** Retry a failed node job. */
|
|
1872
|
+
"node.retry_job": {
|
|
1873
|
+
job_id: string;
|
|
1874
|
+
};
|
|
1875
|
+
/** Schedule the node's deletion. */
|
|
1876
|
+
"node.schedule_deletion": {
|
|
1877
|
+
node_id: string;
|
|
1878
|
+
confirm_name: string;
|
|
1879
|
+
};
|
|
1880
|
+
/** Choose who holds the backup key. */
|
|
1881
|
+
"node.set_backup_custody": {
|
|
1882
|
+
custody: "vault" | "customer";
|
|
1883
|
+
recipient?: string;
|
|
1884
|
+
};
|
|
1885
|
+
/** Hand a rebuild the sealed backup identity. */
|
|
1886
|
+
"node.submit_recovery_kit": {
|
|
1887
|
+
job_id: string;
|
|
1888
|
+
sealed_identity: string;
|
|
1889
|
+
};
|
|
1890
|
+
/** Install the latest signed node release. */
|
|
1891
|
+
"node.upgrade": {
|
|
1892
|
+
node_id: string;
|
|
1893
|
+
};
|
|
1894
|
+
/** Suspected leak: stop every live ping token and issue a new one. */
|
|
1895
|
+
"ping_tokens.reset": {
|
|
1896
|
+
monitor_id: string;
|
|
1897
|
+
};
|
|
1898
|
+
/** End the grace period of the previous ping token now. */
|
|
1899
|
+
"ping_tokens.revoke_previous": {
|
|
1900
|
+
monitor_id: string;
|
|
1901
|
+
};
|
|
1902
|
+
/** Issue a new ping token; the old one works for the grace period. */
|
|
1903
|
+
"ping_tokens.rotate": {
|
|
1904
|
+
monitor_id: string;
|
|
1905
|
+
grace_hours: number;
|
|
1906
|
+
};
|
|
1907
|
+
/** Add a DSN key. */
|
|
1908
|
+
"project_keys.create": {
|
|
1909
|
+
project_id: number;
|
|
1910
|
+
label: string;
|
|
1911
|
+
};
|
|
1912
|
+
/** Revoke a DSN key. */
|
|
1913
|
+
"project_keys.revoke": {
|
|
1914
|
+
key_id: number;
|
|
1915
|
+
};
|
|
1916
|
+
/** Replace a DSN key. */
|
|
1917
|
+
"project_keys.rotate": {
|
|
1918
|
+
key_id: number;
|
|
1919
|
+
};
|
|
1920
|
+
/** Cancel a scheduled project deletion. */
|
|
1921
|
+
"projects.cancel_deletion": {
|
|
1922
|
+
project_id: number;
|
|
1923
|
+
};
|
|
1924
|
+
/** Create a project and its first DSN key. */
|
|
1925
|
+
"projects.create": {
|
|
1926
|
+
name: string;
|
|
1927
|
+
slug: string;
|
|
1928
|
+
platform: "javascript-browser" | "react" | "node" | "python" | "tanstack-start" | "other";
|
|
1929
|
+
};
|
|
1930
|
+
/** One project. */
|
|
1931
|
+
"projects.get": {
|
|
1932
|
+
project_id: number;
|
|
1933
|
+
};
|
|
1934
|
+
/** Projects the token can see. */
|
|
1935
|
+
"projects.list": {
|
|
1936
|
+
limit?: number;
|
|
1937
|
+
cursor?: string;
|
|
1938
|
+
};
|
|
1939
|
+
/** Schedule the project's deletion; `confirm_slug` must repeat its slug. */
|
|
1940
|
+
"projects.schedule_deletion": {
|
|
1941
|
+
project_id: number;
|
|
1942
|
+
confirm_slug: string;
|
|
1943
|
+
};
|
|
1944
|
+
/** Ask the node to send one test event through the public intake. */
|
|
1945
|
+
"projects.send_test_event": {
|
|
1946
|
+
project_id: number;
|
|
1947
|
+
};
|
|
1948
|
+
/** Choose which credentials may send check-ins. */
|
|
1949
|
+
"projects.set_checkin_auth": {
|
|
1950
|
+
project_id: number;
|
|
1951
|
+
mode: "public_or_key" | "key_only";
|
|
1952
|
+
};
|
|
1953
|
+
/** Hide or show an environment in lists. */
|
|
1954
|
+
"projects.set_environment_hidden": {
|
|
1955
|
+
project_id: number;
|
|
1956
|
+
name: string;
|
|
1957
|
+
hidden: boolean;
|
|
1958
|
+
};
|
|
1959
|
+
/** Turn one built-in scrubbing group on or off. */
|
|
1960
|
+
"projects.set_scrub": {
|
|
1961
|
+
project_id: number;
|
|
1962
|
+
group: "credentials" | "cards" | "tokens" | "emails" | "ip" | "user_id" | "headers";
|
|
1963
|
+
enabled: boolean;
|
|
1964
|
+
};
|
|
1965
|
+
/** Rename a project, change its platform or pin it. */
|
|
1966
|
+
"projects.update": {
|
|
1967
|
+
project_id: number;
|
|
1968
|
+
name: string;
|
|
1969
|
+
platform: "javascript-browser" | "react" | "node" | "python" | "tanstack-start" | "other";
|
|
1970
|
+
is_pinned: boolean;
|
|
1971
|
+
};
|
|
1972
|
+
/** Set the project's rate limit, burst and allowed browser origins. */
|
|
1973
|
+
"projects.update_intake": {
|
|
1974
|
+
project_id: number;
|
|
1975
|
+
rate_limit: number | null;
|
|
1976
|
+
burst: number | null;
|
|
1977
|
+
allowed_origins: Array<string>;
|
|
1978
|
+
};
|
|
1979
|
+
/** Set the primary environment and whether monitors may be defined in code. */
|
|
1980
|
+
"projects.update_observability": {
|
|
1981
|
+
project_id: number;
|
|
1982
|
+
primary_environment: string;
|
|
1983
|
+
allow_code_monitors: boolean;
|
|
1984
|
+
};
|
|
1985
|
+
/** Create a service account. */
|
|
1986
|
+
"service_principals.create": {
|
|
1987
|
+
name: string;
|
|
1988
|
+
role: "admin" | "member" | "viewer";
|
|
1989
|
+
description: string;
|
|
1990
|
+
};
|
|
1991
|
+
/** Rename, re-role or disable a service account. */
|
|
1992
|
+
"service_principals.update": {
|
|
1993
|
+
id: string;
|
|
1994
|
+
name: string;
|
|
1995
|
+
role: "admin" | "member" | "viewer";
|
|
1996
|
+
description: string;
|
|
1997
|
+
disabled: boolean;
|
|
1998
|
+
};
|
|
1999
|
+
/** Create an SLO over a monitor, an uptime check or spans. */
|
|
2000
|
+
"slos.create": {
|
|
2001
|
+
name: string;
|
|
2002
|
+
description?: string;
|
|
2003
|
+
source: "uptime" | "monitor" | "heartbeat" | "spans";
|
|
2004
|
+
source_ref: {
|
|
2005
|
+
id?: string;
|
|
2006
|
+
project_id?: number;
|
|
2007
|
+
service?: string;
|
|
2008
|
+
operation?: string;
|
|
2009
|
+
environment?: string;
|
|
2010
|
+
};
|
|
2011
|
+
sli: "availability" | "latency";
|
|
2012
|
+
latency_threshold_ms: number | null;
|
|
2013
|
+
objective: number;
|
|
2014
|
+
window_days: 7 | 28 | 30;
|
|
2015
|
+
alert_policy: "preset_default" | "page_only" | "ticket_only" | "off";
|
|
2016
|
+
allow_public_sources?: boolean;
|
|
2017
|
+
};
|
|
2018
|
+
/** Delete an SLO. */
|
|
2019
|
+
"slos.delete": {
|
|
2020
|
+
slo_id: string;
|
|
2021
|
+
};
|
|
2022
|
+
/** One SLO definition. */
|
|
2023
|
+
"slos.get": {
|
|
2024
|
+
slo_id: string;
|
|
2025
|
+
};
|
|
2026
|
+
/** Import OpenSLO YAML, all or nothing; `dry_run` returns the plan without applying it. */
|
|
2027
|
+
"slos.import": {
|
|
2028
|
+
text: string;
|
|
2029
|
+
dry_run: boolean;
|
|
2030
|
+
};
|
|
2031
|
+
/** SLO definitions. */
|
|
2032
|
+
"slos.list": {
|
|
2033
|
+
limit?: number;
|
|
2034
|
+
cursor?: string;
|
|
2035
|
+
};
|
|
2036
|
+
/** Pause verdicts or mute alerts until a time, `forever` or null. */
|
|
2037
|
+
"slos.set_hold": {
|
|
2038
|
+
slo_id: string;
|
|
2039
|
+
kind: "pause" | "mute";
|
|
2040
|
+
until: string | "forever" | null;
|
|
2041
|
+
};
|
|
2042
|
+
/** Replace an SLO definition. */
|
|
2043
|
+
"slos.update": {
|
|
2044
|
+
slo_id: string;
|
|
2045
|
+
name: string;
|
|
2046
|
+
description?: string;
|
|
2047
|
+
source: "uptime" | "monitor" | "heartbeat" | "spans";
|
|
2048
|
+
source_ref: {
|
|
2049
|
+
id?: string;
|
|
2050
|
+
project_id?: number;
|
|
2051
|
+
service?: string;
|
|
2052
|
+
operation?: string;
|
|
2053
|
+
environment?: string;
|
|
2054
|
+
};
|
|
2055
|
+
sli: "availability" | "latency";
|
|
2056
|
+
latency_threshold_ms: number | null;
|
|
2057
|
+
objective: number;
|
|
2058
|
+
window_days: 7 | 28 | 30;
|
|
2059
|
+
alert_policy: "preset_default" | "page_only" | "ticket_only" | "off";
|
|
2060
|
+
allow_public_sources?: boolean;
|
|
2061
|
+
};
|
|
2062
|
+
/** Span counts and latency over a window. */
|
|
2063
|
+
"spans.histogram": {
|
|
2064
|
+
start?: string;
|
|
2065
|
+
end?: string;
|
|
2066
|
+
project?: string;
|
|
2067
|
+
environment?: string;
|
|
2068
|
+
service?: string;
|
|
2069
|
+
attrs?: string;
|
|
2070
|
+
operation?: string;
|
|
2071
|
+
status?: "unset" | "ok" | "error";
|
|
2072
|
+
};
|
|
2073
|
+
/** Spans (or whole traces with `mode=traces`) in a window of at most 7 days. */
|
|
2074
|
+
"spans.list": {
|
|
2075
|
+
start?: string;
|
|
2076
|
+
end?: string;
|
|
2077
|
+
project?: string;
|
|
2078
|
+
environment?: string;
|
|
2079
|
+
service?: string;
|
|
2080
|
+
attrs?: string;
|
|
2081
|
+
operation?: string;
|
|
2082
|
+
status?: "unset" | "ok" | "error";
|
|
2083
|
+
kind?: "internal" | "server" | "client" | "producer" | "consumer";
|
|
2084
|
+
min_duration_ms?: number;
|
|
2085
|
+
max_duration_ms?: number;
|
|
2086
|
+
mode?: "spans" | "traces";
|
|
2087
|
+
cursor?: string;
|
|
2088
|
+
};
|
|
2089
|
+
/** Stored spans and logs per day and project on the node. */
|
|
2090
|
+
"telemetry.usage": {
|
|
2091
|
+
project?: string;
|
|
2092
|
+
days?: number;
|
|
2093
|
+
};
|
|
2094
|
+
/** A short-lived node ticket (bt2) and the edge URL, so a local client can read the node directly. */
|
|
2095
|
+
"tickets.create": {
|
|
2096
|
+
scope?: "read" | "write";
|
|
2097
|
+
project?: number;
|
|
2098
|
+
environment?: string;
|
|
2099
|
+
};
|
|
2100
|
+
/** Create a personal access token (`blv_pat_`). */
|
|
2101
|
+
"tokens.create_personal": {
|
|
2102
|
+
name: string;
|
|
2103
|
+
scopes: Array<string>;
|
|
2104
|
+
project_ids: Array<number>;
|
|
2105
|
+
environments: Array<string>;
|
|
2106
|
+
expires_in_days: number;
|
|
2107
|
+
};
|
|
2108
|
+
/** Create a service token (`blv_svc_`). */
|
|
2109
|
+
"tokens.create_service": {
|
|
2110
|
+
service_principal_id: string;
|
|
2111
|
+
name: string;
|
|
2112
|
+
scopes: Array<string>;
|
|
2113
|
+
project_ids: Array<number>;
|
|
2114
|
+
environments: Array<string>;
|
|
2115
|
+
expires_in_days: number;
|
|
2116
|
+
};
|
|
2117
|
+
/** Revoke a token; it stops working at once. */
|
|
2118
|
+
"tokens.revoke": {
|
|
2119
|
+
id: string;
|
|
2120
|
+
reason?: string;
|
|
2121
|
+
};
|
|
2122
|
+
/** Set the workspace's longest token lifetime. */
|
|
2123
|
+
"tokens.set_policy": {
|
|
2124
|
+
max_days: number | null;
|
|
2125
|
+
};
|
|
2126
|
+
/** One trace: services, duration, error count. */
|
|
2127
|
+
"traces.get": {
|
|
2128
|
+
trace_id: string;
|
|
2129
|
+
};
|
|
2130
|
+
/** One span with attributes, events and links. */
|
|
2131
|
+
"traces.span": {
|
|
2132
|
+
trace_id: string;
|
|
2133
|
+
span_id: string;
|
|
2134
|
+
start?: string;
|
|
2135
|
+
end?: string;
|
|
2136
|
+
};
|
|
2137
|
+
/** The span waterfall of one trace. */
|
|
2138
|
+
"traces.spans": {
|
|
2139
|
+
trace_id: string;
|
|
2140
|
+
errors_only?: "1";
|
|
2141
|
+
start?: string;
|
|
2142
|
+
end?: string;
|
|
2143
|
+
};
|
|
2144
|
+
/** Create a source map upload token. */
|
|
2145
|
+
"upload_tokens.create": {
|
|
2146
|
+
project_id: number;
|
|
2147
|
+
label: string;
|
|
2148
|
+
};
|
|
2149
|
+
/** Revoke a source map upload token. */
|
|
2150
|
+
"upload_tokens.revoke": {
|
|
2151
|
+
token_id: number;
|
|
2152
|
+
};
|
|
2153
|
+
/** Create an HTTP or TCP uptime check. */
|
|
2154
|
+
"uptime.create": {
|
|
2155
|
+
project_id: number;
|
|
2156
|
+
name: string;
|
|
2157
|
+
kind: "http" | "tcp";
|
|
2158
|
+
url: string | null;
|
|
2159
|
+
host: string | null;
|
|
2160
|
+
port: number | null;
|
|
2161
|
+
method?: "GET" | "HEAD";
|
|
2162
|
+
headers?: Array<{
|
|
2163
|
+
name: string;
|
|
2164
|
+
value: string;
|
|
2165
|
+
}>;
|
|
2166
|
+
follow_redirects?: boolean;
|
|
2167
|
+
timeout_ms: number;
|
|
2168
|
+
interval_seconds: number;
|
|
2169
|
+
regions: Array<"eu" | "us" | "ap">;
|
|
2170
|
+
assertions?: Array<{
|
|
2171
|
+
type: "status";
|
|
2172
|
+
in: Array<string>;
|
|
2173
|
+
} | {
|
|
2174
|
+
type: "body_contains";
|
|
2175
|
+
value: string;
|
|
2176
|
+
case_sensitive?: boolean;
|
|
2177
|
+
} | {
|
|
2178
|
+
type: "body_not_contains";
|
|
2179
|
+
value: string;
|
|
2180
|
+
case_sensitive?: boolean;
|
|
2181
|
+
} | {
|
|
2182
|
+
type: "json_pointer";
|
|
2183
|
+
pointer: string;
|
|
2184
|
+
op: "exists" | "equals" | "type";
|
|
2185
|
+
value?: string;
|
|
2186
|
+
} | {
|
|
2187
|
+
type: "header";
|
|
2188
|
+
name: string;
|
|
2189
|
+
op: "equals" | "contains" | "exists";
|
|
2190
|
+
value?: string;
|
|
2191
|
+
} | {
|
|
2192
|
+
type: "latency_ms";
|
|
2193
|
+
lt: number;
|
|
2194
|
+
} | {
|
|
2195
|
+
type: "tls_valid";
|
|
2196
|
+
}>;
|
|
2197
|
+
failure_threshold: number;
|
|
2198
|
+
recovery_threshold: number;
|
|
2199
|
+
cert_warning_days: number;
|
|
2200
|
+
environment?: string;
|
|
2201
|
+
strict_metadata?: boolean;
|
|
2202
|
+
evidence_on_failure?: boolean;
|
|
2203
|
+
};
|
|
2204
|
+
/** Delete an uptime check. */
|
|
2205
|
+
"uptime.delete": {
|
|
2206
|
+
check_id: string;
|
|
2207
|
+
};
|
|
2208
|
+
/** One uptime check. */
|
|
2209
|
+
"uptime.get": {
|
|
2210
|
+
check_id: string;
|
|
2211
|
+
};
|
|
2212
|
+
/** Uptime checks (header values are never returned). */
|
|
2213
|
+
"uptime.list": {
|
|
2214
|
+
limit?: number;
|
|
2215
|
+
cursor?: string;
|
|
2216
|
+
project_id?: number;
|
|
2217
|
+
};
|
|
2218
|
+
/** Run the check once in each of its regions; results arrive with the next status report. */
|
|
2219
|
+
"uptime.run_now": {
|
|
2220
|
+
check_id: string;
|
|
2221
|
+
};
|
|
2222
|
+
/** Pause runs or mute alerts until a time, `forever` or null. */
|
|
2223
|
+
"uptime.set_hold": {
|
|
2224
|
+
check_id: string;
|
|
2225
|
+
kind: "pause" | "mute";
|
|
2226
|
+
until: string | "forever" | null;
|
|
2227
|
+
};
|
|
2228
|
+
/** Replace an uptime check's target and rules. */
|
|
2229
|
+
"uptime.update": {
|
|
2230
|
+
check_id: string;
|
|
2231
|
+
project_id: number;
|
|
2232
|
+
name: string;
|
|
2233
|
+
kind: "http" | "tcp";
|
|
2234
|
+
url: string | null;
|
|
2235
|
+
host: string | null;
|
|
2236
|
+
port: number | null;
|
|
2237
|
+
method?: "GET" | "HEAD";
|
|
2238
|
+
headers?: Array<{
|
|
2239
|
+
name: string;
|
|
2240
|
+
value: string;
|
|
2241
|
+
}>;
|
|
2242
|
+
follow_redirects?: boolean;
|
|
2243
|
+
timeout_ms: number;
|
|
2244
|
+
interval_seconds: number;
|
|
2245
|
+
regions: Array<"eu" | "us" | "ap">;
|
|
2246
|
+
assertions?: Array<{
|
|
2247
|
+
type: "status";
|
|
2248
|
+
in: Array<string>;
|
|
2249
|
+
} | {
|
|
2250
|
+
type: "body_contains";
|
|
2251
|
+
value: string;
|
|
2252
|
+
case_sensitive?: boolean;
|
|
2253
|
+
} | {
|
|
2254
|
+
type: "body_not_contains";
|
|
2255
|
+
value: string;
|
|
2256
|
+
case_sensitive?: boolean;
|
|
2257
|
+
} | {
|
|
2258
|
+
type: "json_pointer";
|
|
2259
|
+
pointer: string;
|
|
2260
|
+
op: "exists" | "equals" | "type";
|
|
2261
|
+
value?: string;
|
|
2262
|
+
} | {
|
|
2263
|
+
type: "header";
|
|
2264
|
+
name: string;
|
|
2265
|
+
op: "equals" | "contains" | "exists";
|
|
2266
|
+
value?: string;
|
|
2267
|
+
} | {
|
|
2268
|
+
type: "latency_ms";
|
|
2269
|
+
lt: number;
|
|
2270
|
+
} | {
|
|
2271
|
+
type: "tls_valid";
|
|
2272
|
+
}>;
|
|
2273
|
+
failure_threshold: number;
|
|
2274
|
+
recovery_threshold: number;
|
|
2275
|
+
cert_warning_days: number;
|
|
2276
|
+
environment?: string;
|
|
2277
|
+
strict_metadata?: boolean;
|
|
2278
|
+
evidence_on_failure?: boolean;
|
|
2279
|
+
};
|
|
2280
|
+
/** The workspace's plan and limits. */
|
|
2281
|
+
"usage.get": Record<string, never>;
|
|
2282
|
+
/** The token's workspace, plan and the caller's role. */
|
|
2283
|
+
"workspace.get": Record<string, never>;
|
|
2284
|
+
}
|
|
2285
|
+
export type OperationId = keyof OperationParams & keyof typeof OPERATIONS;
|