@dx-do/client 7.18.0 → 8.0.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.
Files changed (116) hide show
  1. package/README.md +1 -14
  2. package/dist/index.cjs.js +36253 -35123
  3. package/dist/index.cjs.js.map +1 -1
  4. package/dist/index.esm.js +35890 -34838
  5. package/dist/index.esm.js.map +1 -1
  6. package/dist/src/index.d.ts +24 -2
  7. package/dist/src/index.d.ts.map +1 -1
  8. package/dist/src/lib/model/alert/PlatformAlert.d.ts +2 -1
  9. package/dist/src/lib/model/alert/PlatformAlert.d.ts.map +1 -1
  10. package/dist/src/lib/model/config/DXSaaSConfiguration.d.ts +0 -4
  11. package/dist/src/lib/model/config/DXSaaSConfiguration.d.ts.map +1 -1
  12. package/dist/src/lib/model/datastore/index.d.ts +1 -0
  13. package/dist/src/lib/model/datastore/index.d.ts.map +1 -1
  14. package/dist/src/lib/model/datastore/metric-data/index.d.ts +2 -0
  15. package/dist/src/lib/model/datastore/metric-data/index.d.ts.map +1 -0
  16. package/dist/src/lib/model/datastore/metric-data/metric-data.d.ts +40 -0
  17. package/dist/src/lib/model/datastore/metric-data/metric-data.d.ts.map +1 -0
  18. package/dist/src/lib/model/log/log-metric-apply.d.ts +69 -0
  19. package/dist/src/lib/model/log/log-metric-apply.d.ts.map +1 -0
  20. package/dist/src/lib/model/log/log-metric.d.ts +222 -0
  21. package/dist/src/lib/model/log/log-metric.d.ts.map +1 -0
  22. package/dist/src/lib/model/maintenance/delete.d.ts +2 -3
  23. package/dist/src/lib/model/maintenance/delete.d.ts.map +1 -1
  24. package/dist/src/lib/model/managementmodule/management-module-export.d.ts +110 -0
  25. package/dist/src/lib/model/managementmodule/management-module-export.d.ts.map +1 -0
  26. package/dist/src/lib/model/managementmodule/management-module-relink.d.ts +30 -0
  27. package/dist/src/lib/model/managementmodule/management-module-relink.d.ts.map +1 -0
  28. package/dist/src/lib/model/managementmodule/management-module-transform-presets.d.ts +4 -0
  29. package/dist/src/lib/model/managementmodule/management-module-transform-presets.d.ts.map +1 -0
  30. package/dist/src/lib/model/managementmodule/management-module-transform.d.ts +110 -0
  31. package/dist/src/lib/model/managementmodule/management-module-transform.d.ts.map +1 -0
  32. package/dist/src/lib/model/metricgrouping/PlatformMetricGrouping.d.ts +23 -3
  33. package/dist/src/lib/model/metricgrouping/PlatformMetricGrouping.d.ts.map +1 -1
  34. package/dist/src/lib/model/metricgrouping/metric-grouping-filter.d.ts +42 -0
  35. package/dist/src/lib/model/metricgrouping/metric-grouping-filter.d.ts.map +1 -0
  36. package/dist/src/lib/model/synthetics/auth.d.ts +220 -0
  37. package/dist/src/lib/model/synthetics/auth.d.ts.map +1 -0
  38. package/dist/src/lib/model/synthetics/check.d.ts +367 -0
  39. package/dist/src/lib/model/synthetics/check.d.ts.map +1 -0
  40. package/dist/src/lib/model/synthetics/common.d.ts +165 -0
  41. package/dist/src/lib/model/synthetics/common.d.ts.map +1 -0
  42. package/dist/src/lib/model/synthetics/create.d.ts +3366 -0
  43. package/dist/src/lib/model/synthetics/create.d.ts.map +1 -0
  44. package/dist/src/lib/model/synthetics/errors.d.ts +102 -0
  45. package/dist/src/lib/model/synthetics/errors.d.ts.map +1 -0
  46. package/dist/src/lib/model/synthetics/examples.d.ts +24 -0
  47. package/dist/src/lib/model/synthetics/examples.d.ts.map +1 -0
  48. package/dist/src/lib/model/synthetics/location.d.ts +46 -0
  49. package/dist/src/lib/model/synthetics/location.d.ts.map +1 -0
  50. package/dist/src/lib/model/synthetics/monitor.d.ts +456 -0
  51. package/dist/src/lib/model/synthetics/monitor.d.ts.map +1 -0
  52. package/dist/src/lib/model/synthetics/params.d.ts +806 -0
  53. package/dist/src/lib/model/synthetics/params.d.ts.map +1 -0
  54. package/dist/src/lib/model/synthetics/query.d.ts +297 -0
  55. package/dist/src/lib/model/synthetics/query.d.ts.map +1 -0
  56. package/dist/src/lib/model/synthetics/schedule.d.ts +93 -0
  57. package/dist/src/lib/model/synthetics/schedule.d.ts.map +1 -0
  58. package/dist/src/lib/model/synthetics/script.d.ts +64 -0
  59. package/dist/src/lib/model/synthetics/script.d.ts.map +1 -0
  60. package/dist/src/lib/model/synthetics/state.d.ts +645 -0
  61. package/dist/src/lib/model/synthetics/state.d.ts.map +1 -0
  62. package/dist/src/lib/model/synthetics/update.d.ts +378 -0
  63. package/dist/src/lib/model/synthetics/update.d.ts.map +1 -0
  64. package/dist/src/lib/services/datastore/datastore-metric-data.service.d.ts +19 -0
  65. package/dist/src/lib/services/datastore/datastore-metric-data.service.d.ts.map +1 -0
  66. package/dist/src/lib/services/dx-saas.service.d.ts +19 -1
  67. package/dist/src/lib/services/dx-saas.service.d.ts.map +1 -1
  68. package/dist/src/lib/services/log-metric.service.d.ts +112 -0
  69. package/dist/src/lib/services/log-metric.service.d.ts.map +1 -0
  70. package/dist/src/lib/services/logs.service.d.ts +3 -1
  71. package/dist/src/lib/services/logs.service.d.ts.map +1 -1
  72. package/dist/src/lib/services/platform-management-module.service.d.ts +49 -4
  73. package/dist/src/lib/services/platform-management-module.service.d.ts.map +1 -1
  74. package/dist/src/lib/services/platform-metric-grouping.service.d.ts +14 -0
  75. package/dist/src/lib/services/platform-metric-grouping.service.d.ts.map +1 -1
  76. package/dist/src/lib/services/service-monolith.d.ts +6 -2
  77. package/dist/src/lib/services/service-monolith.d.ts.map +1 -1
  78. package/dist/src/lib/services/synthetic-monitor.service.d.ts +417 -0
  79. package/dist/src/lib/services/synthetic-monitor.service.d.ts.map +1 -0
  80. package/package.json +1 -1
  81. package/dist/src/lib/model/asm/client/client/client.gen.d.ts +0 -3
  82. package/dist/src/lib/model/asm/client/client/client.gen.d.ts.map +0 -1
  83. package/dist/src/lib/model/asm/client/client/index.d.ts +0 -11
  84. package/dist/src/lib/model/asm/client/client/index.d.ts.map +0 -1
  85. package/dist/src/lib/model/asm/client/client/types.gen.d.ts +0 -88
  86. package/dist/src/lib/model/asm/client/client/types.gen.d.ts.map +0 -1
  87. package/dist/src/lib/model/asm/client/client/utils.gen.d.ts +0 -15
  88. package/dist/src/lib/model/asm/client/client/utils.gen.d.ts.map +0 -1
  89. package/dist/src/lib/model/asm/client/client.gen.d.ts +0 -13
  90. package/dist/src/lib/model/asm/client/client.gen.d.ts.map +0 -1
  91. package/dist/src/lib/model/asm/client/core/auth.gen.d.ts +0 -26
  92. package/dist/src/lib/model/asm/client/core/auth.gen.d.ts.map +0 -1
  93. package/dist/src/lib/model/asm/client/core/bodySerializer.gen.d.ts +0 -26
  94. package/dist/src/lib/model/asm/client/core/bodySerializer.gen.d.ts.map +0 -1
  95. package/dist/src/lib/model/asm/client/core/params.gen.d.ts +0 -44
  96. package/dist/src/lib/model/asm/client/core/params.gen.d.ts.map +0 -1
  97. package/dist/src/lib/model/asm/client/core/pathSerializer.gen.d.ts +0 -34
  98. package/dist/src/lib/model/asm/client/core/pathSerializer.gen.d.ts.map +0 -1
  99. package/dist/src/lib/model/asm/client/core/queryKeySerializer.gen.d.ts +0 -19
  100. package/dist/src/lib/model/asm/client/core/queryKeySerializer.gen.d.ts.map +0 -1
  101. package/dist/src/lib/model/asm/client/core/serverSentEvents.gen.d.ts +0 -72
  102. package/dist/src/lib/model/asm/client/core/serverSentEvents.gen.d.ts.map +0 -1
  103. package/dist/src/lib/model/asm/client/core/types.gen.d.ts +0 -84
  104. package/dist/src/lib/model/asm/client/core/types.gen.d.ts.map +0 -1
  105. package/dist/src/lib/model/asm/client/core/utils.gen.d.ts +0 -20
  106. package/dist/src/lib/model/asm/client/core/utils.gen.d.ts.map +0 -1
  107. package/dist/src/lib/model/asm/client/index.d.ts +0 -3
  108. package/dist/src/lib/model/asm/client/index.d.ts.map +0 -1
  109. package/dist/src/lib/model/asm/client/schemas.gen.d.ts +0 -4522
  110. package/dist/src/lib/model/asm/client/schemas.gen.d.ts.map +0 -1
  111. package/dist/src/lib/model/asm/client/sdk.gen.d.ts +0 -585
  112. package/dist/src/lib/model/asm/client/sdk.gen.d.ts.map +0 -1
  113. package/dist/src/lib/model/asm/client/types.gen.d.ts +0 -4877
  114. package/dist/src/lib/model/asm/client/types.gen.d.ts.map +0 -1
  115. package/dist/src/lib/services/asm.service.d.ts +0 -22
  116. package/dist/src/lib/services/asm.service.d.ts.map +0 -1
@@ -1,4877 +0,0 @@
1
- export type ClientOptions = {
2
- baseURL: `${string}://${string}/{version}` | (string & {});
3
- };
4
- export type ApiTokenNotFound = {
5
- status?: string;
6
- message?: string;
7
- };
8
- export type ApiToken = {
9
- id?: number;
10
- name?: string;
11
- valid_until?: string | null;
12
- created?: string;
13
- };
14
- export type ContactAuth = {
15
- /**
16
- * The supported authentication method.
17
- */
18
- type: 'basic' | 'bearer';
19
- /**
20
- * User name if the authentication type requires it
21
- */
22
- user?: string | null;
23
- /**
24
- * The authentication secret or token. This value is not sent in GET requests, it can only be created or updated.
25
- */
26
- secret?: string | null;
27
- };
28
- export type ContactCatalogue = {
29
- folders: Array<ResourceGroupItemWithPermission>;
30
- contacts: Array<ContactItem>;
31
- };
32
- export type ContactItem = {
33
- id: number;
34
- name: string;
35
- /**
36
- * Group contacts are containers for standard contacts - members.
37
- */
38
- type: 'email' | 'sms' | 'phone' | 'action' | 'rss' | 'group';
39
- /**
40
- * Not used for group contact type
41
- */
42
- address?: string;
43
- /**
44
- * 0=invalid,1=unconfirmed,2=active,3=blocked,4=inactive
45
- */
46
- status: 0 | 1 | 2 | 3 | 4;
47
- default: boolean;
48
- ownerId?: number;
49
- folderId?: number | null;
50
- /**
51
- * Time HH:ss in contact's time zone; workingFrom and workingTo represent time interval when the contact can be alerted.
52
- */
53
- workingFrom?: string;
54
- /**
55
- * Time HH:ss in contact's time zone; workingFrom and workingTo represent time interval when the contact can be alerted.
56
- */
57
- workingTo?: string;
58
- /**
59
- * Days when the contact can be used for alerting. 0 = Monday ... 6 = Sunday
60
- */
61
- workingDays?: Array<number>;
62
- /**
63
- * This time zone is used both for date formating in alert messages and for the contact's working hours (workingFrom, workingTo). If empty the time zone of the account is assumed.
64
- */
65
- timezone?: string | null;
66
- /**
67
- * For contact groups it contains list of members. For all but contact groups it contains list of groups this contact is member of.
68
- */
69
- members?: Array<ContactGroupMemberItem>;
70
- /**
71
- * Authentication details. Authentication can be added for the action url contact type only.
72
- */
73
- auth?: ContactAuth | {
74
- [key: string]: unknown;
75
- } | null;
76
- /**
77
- * Special flags specific for the contact type. Currently, only action contact type supports specifications.
78
- * Json changes the content type for the action url to send message as a json instead of standard application/x-www-form-urlencoded.
79
- * gchat changes both content type and message form to send message to a Google chat webhook.
80
- */
81
- specification?: 'json' | 'gchat';
82
- };
83
- export type ContactItemCreate = ContactItemUpdate & {
84
- type: 'email' | 'sms' | 'phone' | 'action' | 'rss' | 'group';
85
- };
86
- export type ContactItemUpdate = {
87
- name?: string | null;
88
- /**
89
- * Address of the contact. The scheme depends on the contact type.
90
- */
91
- address?: string | null;
92
- /**
93
- * Is this contact the default account contact? Only one contact can be default.
94
- */
95
- default?: boolean | null;
96
- /**
97
- * ID of the folder this contact should be assigned to
98
- */
99
- folderId?: number | null;
100
- /**
101
- * Time HH:ss in contact's time zone; workingFrom and workingTo represent time interval when the contact can be alerted. Do not use for contact groups.
102
- */
103
- workingFrom?: string;
104
- /**
105
- * Time HH:ss in contact's time zone; workingFrom and workingTo represent time interval when the contact can be alerted. Do not use for contact groups.
106
- */
107
- workingTo?: string | null;
108
- /**
109
- * Days when the contact can be alerted. Do not use for contact groups.
110
- */
111
- workingDays?: Array<number> | null;
112
- /**
113
- * This time zone is used both for date formating in alert messages and for the contact's working hours (workingFrom, workingTo). Set the time zone only if you want another TZ for this particular contact, the time zone of the account is assumed by default. For updating use null to reset TZ, omit completely to keep the current value. Do not use for contact groups.
114
- */
115
- timezone?: string | null;
116
- /**
117
- * For all contact types but group this parameter must be empty. For contact groups it is required and must contain list of member contact IDs.
118
- */
119
- members?: Array<ContactGroupMemberCreate> | null;
120
- /**
121
- * Authentication details. Authentication can be added for the action url contact type only.
122
- */
123
- auth?: ContactAuth | {
124
- [key: string]: unknown;
125
- } | null;
126
- /**
127
- * Special flags specific for the contact type. Currently, only action contact type supports specifications.
128
- * Json changes the content type for the action url to send message as a json instead of standard application/x-www-form-urlencoded.
129
- * gchat changes both content type and message form to send message to a Google chat webhook.
130
- */
131
- specification?: 'json' | 'gchat';
132
- };
133
- export type ContactGroupMemberItem = {
134
- /**
135
- * ID of the contact (member of the group)
136
- */
137
- contactId: number;
138
- /**
139
- * ID of the group (contact of type group) the contact is member of
140
- */
141
- groupId: number;
142
- /**
143
- * Send alert after (alertAfter-1) errors. 0 means alert immediately (after 1 error), 1 after 2 errors, etc.
144
- */
145
- alertAfter: 0 | 1 | 2 | 3 | 4;
146
- };
147
- export type ContactGroupMemberCreate = {
148
- /**
149
- * ID of the contact (member of the group)
150
- */
151
- contactId: number;
152
- /**
153
- * Send alert after (alertAfter-1) errors. 0 means alert immediately (after 1 error), 1 after 2 errors, etc.
154
- */
155
- alertAfter: 0 | 1 | 2 | 3 | 4;
156
- };
157
- export type MaintenanceCatalogue = {
158
- folders: Array<ResourceGroupItemWithPermission>;
159
- maintenances: Array<MaintenanceItem>;
160
- };
161
- export type MaintenanceItem = {
162
- id: number;
163
- name: string;
164
- timezone: string;
165
- ruleCount: number;
166
- description?: string;
167
- persistent?: boolean;
168
- windows?: Array<MaintenanceWindowItem>;
169
- permission?: PermissionItem;
170
- ownerId?: number;
171
- folderId?: number | null;
172
- monitorIds?: Array<number>;
173
- immediateForRuleId?: number | null;
174
- };
175
- export type MaintenanceItemCreate = {
176
- name?: string;
177
- timezone?: string;
178
- description?: string;
179
- persistent?: boolean;
180
- windows?: Array<WindowItemCreate>;
181
- folderId?: number | null;
182
- monitorIds?: Array<number>;
183
- };
184
- export type MaintenanceItemImmediateCreate = {
185
- /**
186
- * Start of the maintenance window, current time if empty. Format: ISO 8601 date and time with or without timezone. Current user's timezone is used by default.
187
- */
188
- from?: string | null;
189
- /**
190
- * Duration of the immediate maintenance window, format [H][H]H:MM
191
- */
192
- duration: string;
193
- /**
194
- * Ids of monitors this maintenance should be assigned to. You need update permission for these monitors
195
- */
196
- monitorIds: Array<number>;
197
- };
198
- export type MaintenanceWindowItem = {
199
- id?: number | null;
200
- type: 'fixed' | 'daily' | 'weekly' | 'monthly';
201
- status: 'active' | 'waiting' | 'passed';
202
- from: string;
203
- to?: string;
204
- effectiveTo?: string;
205
- /**
206
- * For repeating time windows means repeat every N (days, weeks, months).
207
- */
208
- repeat?: number | null;
209
- /**
210
- * For weekly recurring time window: 0 - Monday, 6 - Sunday
211
- */
212
- dow?: Array<number> | null;
213
- };
214
- export type WindowItemCreate = {
215
- /**
216
- * This parameter is always required
217
- */
218
- type?: 'fixed' | 'daily' | 'weekly' | 'montly';
219
- /**
220
- * This parameter is always required. The time can either be specified without the time zone or with timezone. In the first case, the maintenance window TZ is used, in the latter case the time zone is respected but translated to the TZ of the maintenance window.
221
- */
222
- from?: string;
223
- /**
224
- * End time of this window applicability. Required for these types: fixed
225
- */
226
- to?: string;
227
- /**
228
- * For repeating time windows means repeat every N (days, weeks, months). Required for all but fixed type.
229
- */
230
- repeat?: number | null;
231
- /**
232
- * The end time for repeatable time windows. This value is in the same TZ as the from field (either explicit or inherited from the maintenance window it belongs to). Required for these types: daily, weekly, monthly.
233
- */
234
- endTime?: string | null;
235
- /**
236
- * For weekly recurring time window applicable days: 0 - Monday, 6 - Sunday.
237
- */
238
- dow?: Array<number> | null;
239
- };
240
- export type MessageItem = {
241
- id: number;
242
- entered: string;
243
- sent?: string | null;
244
- /**
245
- * Monitor ID
246
- */
247
- monitorId?: number | null;
248
- /**
249
- * Contact ID
250
- */
251
- contactId?: number | null;
252
- /**
253
- * Contact type
254
- */
255
- type: 'email' | 'sms' | 'phone' | 'action' | 'rss';
256
- /**
257
- * Monitor ID
258
- */
259
- address?: string;
260
- /**
261
- * Message delivery status
262
- */
263
- status: 'deleted' | 'queued' | 'gateway' | 'provider' | 'device' | 'accepted' | 'queued-no-fallback' | 'undeliverable' | 'suppressed';
264
- /**
265
- * Monitor log event uuid
266
- */
267
- eventId?: string | null;
268
- /**
269
- * Text of the message
270
- */
271
- message?: string;
272
- };
273
- /**
274
- * This schema is used to return a page from the list of monitors with additional pagination information
275
- */
276
- export type MonitorsPage = {
277
- /**
278
- * List of monitors.
279
- */
280
- monitors?: Array<Browser | Connect | Dns | Dnsa | Dnsns | Domain | Ftp | Ftps | Http | Https | Imap | Ldap | Ping | Plugin | Pop3 | Scp | Script | Sftp | Sip | Smtp | Telnet | Webdriver>;
281
- /**
282
- * Number of monitors returned in the monitors array.
283
- */
284
- numMonitors?: number;
285
- /**
286
- * Number of unique folders returned the returned monitors belong to. These folders are also attached in the folders array.
287
- */
288
- numFolders?: number;
289
- /**
290
- * Number of monitors out of folder in the response
291
- */
292
- numNotInFolder?: number;
293
- /**
294
- * Total number of monitors that would be returned if no limit/offset restriction is applied
295
- */
296
- totalMonitors?: number;
297
- /**
298
- * Total number of folders that would be returned if no limit/offset restriction is applied
299
- */
300
- totalFolders?: number;
301
- /**
302
- * Total number of monitors out of folder if no limit/offset restriction is applied
303
- */
304
- totalNotInFolder?: number;
305
- folders?: FolderItem;
306
- };
307
- export type OauthClientCredentialsNotFound = {
308
- status?: string;
309
- message?: string;
310
- };
311
- export type OauthClientCredentialsItem = {
312
- id?: number;
313
- name?: string;
314
- client_id?: string;
315
- valid_until?: string | null;
316
- access_token_validity?: number | null;
317
- refresh_token_validity?: number | null;
318
- };
319
- export type OauthToken = {
320
- id?: number;
321
- /**
322
- * Client ID this token is assigned to.
323
- */
324
- clientId?: number;
325
- /**
326
- * Date and time when the token expires
327
- */
328
- expires?: string;
329
- };
330
- export type PermissionItem = {
331
- type: string;
332
- level: string;
333
- };
334
- export type ResourceGroupItem = {
335
- id?: number;
336
- name?: string;
337
- ownerId?: number;
338
- };
339
- export type ResourceGroupItemWithPermission = ResourceGroupItem & {
340
- resourceCount?: number;
341
- permission?: PermissionItem;
342
- };
343
- export type BulkResponseMetadata = {
344
- /**
345
- * A bulk response containing multiple sub-responses for bulk operations
346
- */
347
- success?: number;
348
- redirect?: number;
349
- client_errors?: number;
350
- server_errors?: number;
351
- };
352
- export type BulkResponse = {
353
- metadata?: BulkResponseMetadata;
354
- responses?: Array<BulkResponsePart>;
355
- };
356
- /**
357
- * One part of a multi-part response
358
- *
359
- * When performing bulk operations, each item has its own response
360
- * This class represents response for one item
361
- *
362
- * It is merged in BulkResponse
363
- */
364
- export type BulkResponsePart = {
365
- /**
366
- * ID of the entity this response is connected to (user ID, folder ID...)
367
- */
368
- id: string | number;
369
- /**
370
- * This property is renamed in BulkResponse::getCompleteResponse()
371
- */
372
- status: number;
373
- /**
374
- * This property is renamed in BulkResponse::getCompleteResponse()
375
- */
376
- resource?: {
377
- [key: string]: unknown;
378
- };
379
- /**
380
- * The subresponse HTTP message
381
- */
382
- message?: string | null;
383
- };
384
- export type FolderItem = FolderRequestItem & {
385
- id: number;
386
- monitorCount: number;
387
- permission?: PermissionItem;
388
- specificPermission?: PermissionItem;
389
- ownerId?: number;
390
- };
391
- export type FolderRequestItem = {
392
- name: string;
393
- isActive: boolean;
394
- notifyOn: boolean;
395
- };
396
- export type Forbidden = {
397
- status?: string;
398
- message?: string;
399
- };
400
- export type SettingsItem = {
401
- name: string;
402
- type?: 'bool' | 'integer' | 'string' | 'secret' | 'integers';
403
- value: string | number | boolean | Array<number>;
404
- };
405
- export type StationAgent = {
406
- /**
407
- * Monitor type
408
- */
409
- type?: string;
410
- /**
411
- * Agent name
412
- */
413
- agent?: string;
414
- };
415
- export type StationAgents = {
416
- /**
417
- * Number of ccagents
418
- */
419
- ccagent?: number | null;
420
- /**
421
- * Number of cbot agents
422
- */
423
- cbot?: number | null;
424
- /**
425
- * Number of full-page agents
426
- */
427
- fpm?: number | null;
428
- /**
429
- * Number of jmeter2 agents
430
- */
431
- jmeter2?: number | null;
432
- /**
433
- * Number of jmeter4 agents
434
- */
435
- jmeter4?: number | null;
436
- /**
437
- * Number of jmeter5 agents
438
- */
439
- jmeter5?: number | null;
440
- /**
441
- * Number of webdriver agents
442
- */
443
- webdriver?: number | null;
444
- };
445
- export type StationItem = {
446
- id?: number;
447
- /**
448
- * The unique host name of this monitoring station
449
- */
450
- alias?: string;
451
- /**
452
- * The location ID this station belongs to
453
- */
454
- locationId?: number;
455
- /**
456
- * True if the monitoring station is public.
457
- */
458
- isPublic?: boolean;
459
- /**
460
- * ID of the monitoring station owner. Public stations have no owners.
461
- */
462
- ownerId?: number | null;
463
- /**
464
- * The short code assigned during installation - deprecated
465
- */
466
- locode?: string;
467
- /**
468
- * Status of the monitoring station: 1 - planned, 2 - active, 3 - in maintenance, 4 - blocked, 5 - installation in progress, 6 = broken - installation failed.
469
- */
470
- status?: 1 | 2 | 3 | 4 | 3 | 5 | 6;
471
- /**
472
- * The IP address of this monitoring station
473
- */
474
- host?: string | null;
475
- city?: string;
476
- latitude?: number;
477
- longitude?: number;
478
- /**
479
- * Weight of the station in the location.
480
- */
481
- weight?: number;
482
- /**
483
- * The version of the OS
484
- */
485
- osVersion?: string;
486
- /**
487
- * The version of the ASM station installed
488
- */
489
- version?: string;
490
- /**
491
- * Custom text description.
492
- */
493
- description?: string;
494
- /**
495
- * Engine used for orchestration - kubernetes, docker-composer, etc.
496
- */
497
- engine?: string;
498
- /**
499
- * Use ccagent instead of cbot
500
- */
501
- useCcagent?: boolean;
502
- };
503
- export type StationItemCreate = {
504
- /**
505
- * The host name of this monitoring station
506
- */
507
- alias?: string;
508
- /**
509
- * The location ID this station belongs to
510
- */
511
- locationId?: number;
512
- /**
513
- * Status of the monitoring station: 1 - planned, 2 - active, 3 - in maintenance, 4 - blocked.
514
- */
515
- status?: 1 | 2 | 3 | 4 | 3;
516
- /**
517
- * The IP address of this monitoring station
518
- */
519
- host?: string | null;
520
- city?: string;
521
- latitude?: number;
522
- longitude?: number;
523
- /**
524
- * Weight of the station in the location.
525
- */
526
- weight?: number;
527
- /**
528
- * The version of the OS
529
- */
530
- osVersion?: string;
531
- /**
532
- * The version of the ASM station installed
533
- */
534
- version?: string;
535
- /**
536
- * This secret is used to encrypt station debug information (status, config, logs). If not provided, the debug information is not available.
537
- */
538
- secret?: string;
539
- /**
540
- * Custom text description.
541
- */
542
- description?: string;
543
- /**
544
- * Metadata for the installer (json encoded). Internal use only.
545
- */
546
- installerMetadata?: string;
547
- /**
548
- * Engine used for orchestration - kubernetes, docker-composer, etc.
549
- */
550
- engine?: string;
551
- /**
552
- * Use ccagent instead of cbot
553
- */
554
- useCcagent?: boolean;
555
- agents?: StationAgents | {
556
- [key: string]: unknown;
557
- } | null;
558
- };
559
- export type StationItemDetail = StationItem & {
560
- /**
561
- * Tunnel ID.
562
- */
563
- tunnelId?: string;
564
- /**
565
- * Installation token - it is generated when monitoring station is created or updated or if you request one station details.
566
- */
567
- token?: string | null;
568
- /**
569
- * Metadata for the installer (json encoded).
570
- */
571
- installerMetadata?: string;
572
- agents?: StationAgents | {
573
- [key: string]: unknown;
574
- } | null;
575
- };
576
- export type StationLatest = {
577
- /**
578
- * The current version of the station
579
- */
580
- version?: string;
581
- /**
582
- * The current version of the installer
583
- */
584
- installer?: string;
585
- };
586
- export type TimezoneItem = {
587
- /**
588
- * The name of this timezone
589
- */
590
- name?: string;
591
- /**
592
- * [+-]HH:mm offset to UTC
593
- */
594
- offset?: string;
595
- /**
596
- * True if the timezone observes/observed DST for the year of the call
597
- */
598
- hasDst?: boolean;
599
- /**
600
- * True if the timezone is in DST at the time of the call
601
- */
602
- isDst?: boolean;
603
- };
604
- /**
605
- * Class User
606
- */
607
- export type User = UserCreate & {
608
- id: number;
609
- /**
610
- * Date time of last login
611
- */
612
- lastseen?: string;
613
- /**
614
- * Status (read only)
615
- * 1 ... unconfirmed
616
- * 2 ... active
617
- * 3 ... blocked
618
- * 4 ... unsubscribing
619
- * 5 ... on hold
620
- */
621
- status?: number;
622
- /**
623
- * List of custom roles the user is member of (read only)
624
- */
625
- roles?: Array<Role>;
626
- /**
627
- * Is account locked?
628
- */
629
- locked?: boolean;
630
- /**
631
- * True/false if user can login as parent account (owner), null if not evaulated
632
- */
633
- canLoginAsParent?: boolean | null;
634
- };
635
- /**
636
- * Class UserCreate
637
- */
638
- export type UserCreate = {
639
- email: string;
640
- name: string;
641
- company?: string;
642
- website?: string;
643
- address?: string;
644
- city?: string;
645
- zip?: string;
646
- state?: string;
647
- /**
648
- * ISO 3166-1 alpha-2 country code
649
- */
650
- country?: string;
651
- lang?: string;
652
- timezone?: string;
653
- };
654
- export type Role = RoleCreate & {
655
- /**
656
- * Unique role ID
657
- */
658
- id?: number;
659
- /**
660
- * Unique role name. Use role ID instead, this value is deprecated.
661
- */
662
- name: string;
663
- };
664
- export type RoleCreate = {
665
- description: string;
666
- };
667
- /**
668
- * Class Location
669
- */
670
- export type Location = LocationDraft & {
671
- /**
672
- * Unique ID of the location.
673
- */
674
- id: number;
675
- /**
676
- * Parent location ID.
677
- */
678
- parent: number | null;
679
- /**
680
- * Iso code of the country this location belongs to or null.
681
- */
682
- country?: string;
683
- /**
684
- * If true, it is a private (on-premise) location. Otherwise it is a public one.
685
- */
686
- isPrivate?: boolean;
687
- /**
688
- * Can the user create nested locations to this location?
689
- */
690
- canCreateLocations?: boolean;
691
- /**
692
- * Can the user create private monitoring stations in this location?
693
- */
694
- canCreateStations?: boolean;
695
- /**
696
- * Location region details
697
- */
698
- region?: Region | {
699
- [key: string]: unknown;
700
- } | null;
701
- };
702
- /**
703
- * Class LocationDraft
704
- */
705
- export type LocationDraft = {
706
- /**
707
- * Name of the location.
708
- */
709
- name: string;
710
- /**
711
- * Parent location ID or country 2-char iso code.
712
- */
713
- parent: string;
714
- /**
715
- * Latitude of the location - position can be used to find the nearest location in scheduler.
716
- */
717
- latitude?: number;
718
- /**
719
- * Longitude of the location - position can be used to find the nearest location in scheduler.
720
- */
721
- longitude?: number;
722
- /**
723
- * Weight is used to prefer or disfavor this group.
724
- */
725
- weight?: number;
726
- };
727
- /**
728
- * Class Region
729
- */
730
- export type Region = {
731
- /**
732
- * ID of the region.
733
- */
734
- id?: number;
735
- /**
736
- * Name of the region.
737
- */
738
- name?: string | null;
739
- };
740
- /**
741
- * Add support for certificates to converters
742
- */
743
- export type AllowDenyTrait = {
744
- browserRestriction?: 'own' | 'everywhere' | 'custom';
745
- /**
746
- * Comma-separated whitelisted domains. This will be an array in the future
747
- */
748
- browserAllow?: string;
749
- /**
750
- * Comma-separated blacklisted domains. This will be an array in the future
751
- */
752
- browserDeny?: string;
753
- };
754
- export type UseCertificatesTrait = {
755
- useClientCert?: boolean;
756
- useCaCert?: boolean;
757
- certificates?: MonitorCertificates | {
758
- [key: string]: unknown;
759
- } | null;
760
- };
761
- /**
762
- * Encryption-settable monitor
763
- */
764
- export type EncryptionTrait = {
765
- cipherList?: 'ALL' | 'HIGH' | 'MEDIUM' | '';
766
- /**
767
- * TODO: "" = negotiate? why nullable then? see in initializeEncryption
768
- */
769
- encryption?: 'tls' | 'tlsv1.0' | 'tlsv1.1' | 'tlsv1.2' | 'sslv3' | '';
770
- };
771
- /**
772
- * Add host:port support to the monitor schema - this may seem odd, but there are URL monitors, host:port monitors and script monitors
773
- *
774
- * Use in \Cm\Lib\Monitor\Schema\AbstractMonitor and its descendants
775
- */
776
- export type HostPortTrait = {
777
- host?: string;
778
- port?: number;
779
- };
780
- /**
781
- * Add IP version selection support to the monitor schema
782
- *
783
- * Use in \Cm\Lib\Monitor\Schema\AbstractMonitor and its descendants
784
- */
785
- export type IpVersionTrait = {
786
- ipVersion?: 0 | 4 | 6;
787
- };
788
- /**
789
- * Add login support to the monitor schema
790
- *
791
- * Use in \Cm\Lib\Monitor\Schema\AbstractMonitor and its descendants
792
- */
793
- export type LoginTrait = {
794
- username?: string;
795
- password?: string;
796
- };
797
- /**
798
- * Add match string/regex support to the monitor schema
799
- *
800
- * Use in \Cm\Lib\Monitor\Schema\AbstractMonitor and its descendants
801
- */
802
- export type MatchStringTrait = {
803
- matchString?: string;
804
- };
805
- /**
806
- * Add post data support to the monitor schema
807
- *
808
- * Use in \Cm\Lib\Monitor\Schema\AbstractMonitor and its descendants
809
- */
810
- export type PostDataTrait = {
811
- /**
812
- * Enable this option if POST, PUT or PATCH data is in a binary form. This value is disregarded on OPMS before 10.7.
813
- */
814
- binary?: boolean;
815
- /**
816
- * Data sent with the PUT, POST and PATCH requests. Binary data must be base64 encoded.
817
- */
818
- data?: string;
819
- };
820
- /**
821
- * Add proxy support to the monitor schema
822
- */
823
- export type ProxyTrait = {
824
- useProxy?: boolean;
825
- /**
826
- * The proxy protocol. Not all monitor types can make use of all proxy protocols. useProxy=true and proxyProtocol=null means 'use system proxy' on OPMS
827
- */
828
- proxyProtocol?: 'http' | 'https' | 'socks5';
829
- proxyAddress?: string | null;
830
- proxyPort?: number | null;
831
- proxyUsername?: string | null;
832
- proxyPassword?: string | null;
833
- };
834
- export type RequestHeadersTrait = {
835
- requestHeaders?: string;
836
- };
837
- export type TransactionPatternsTrait = {
838
- transactionPatterns?: string | null;
839
- };
840
- /**
841
- * Add host:port support to the monitor schema - this may seem odd, but there are URL monitors, host:port monitors and script monitors
842
- *
843
- * Use in \Cm\Lib\Monitor\Schema\AbstractMonitor and its descendants
844
- */
845
- export type UrlTrait = {
846
- url?: string;
847
- };
848
- /**
849
- * User-Agent-settable monitor
850
- */
851
- export type UserAgentTrait = {
852
- /**
853
- * Free format user agent to be used with requests, default empty string = native for the agent
854
- */
855
- userAgent?: string;
856
- };
857
- /**
858
- * monitor allowing verify certificate setting
859
- */
860
- export type VerifyCertificateTrait = {
861
- verifyCertificate?: boolean;
862
- };
863
- /**
864
- * Common fields present for all monitors
865
- */
866
- export type Monitor = MonitorCreate & {
867
- id?: number;
868
- /**
869
- * Status of the monitor (read only). The status of the folder is not reflected.
870
- */
871
- status?: 'deleted' | 'inactive' | 'active' | 'unconfirmed' | 'locked' | 'error';
872
- /**
873
- * Health status of the monitoring station pool (read only). This flag is true if the number of monitoring stations in insufficient.
874
- */
875
- unhealthy?: boolean | null;
876
- /**
877
- * Is monitor currently in maintenance mode? (read only)
878
- */
879
- inMaintenance?: boolean | null;
880
- };
881
- /**
882
- * Common fields for creating any monitor
883
- */
884
- export type MonitorCreate = MonitorUpdate & {
885
- /**
886
- * The monitor type.
887
- */
888
- type: 'http' | 'https' | 'connect' | 'dns' | 'dnsa' | 'dnsns' | 'domain' | 'ftp' | 'ftps' | 'imap' | 'ldap' | 'ping' | 'plugin' | 'pop3' | 'scp' | 'sftp' | 'sip' | 'smtp' | 'telnet' | 'browser' | 'script' | 'tls' | 'websocket';
889
- };
890
- /**
891
- * Common updatable fields for all monitors
892
- */
893
- export type MonitorUpdate = {
894
- name?: string;
895
- /**
896
- * The folder id where the monitor will be put. 0 means no folder.
897
- */
898
- folderId?: number;
899
- maintenanceGroupIds?: Array<number>;
900
- tagNames?: Array<string>;
901
- transactionTag?: string;
902
- userNote?: string;
903
- /**
904
- * This time zone is used for the monitor's run hours (check/periodFrom, check/periodTo and check/days). If empty the time zone of the owner account is used.
905
- */
906
- timezone?: string | null;
907
- check?: MonitorCheck;
908
- alert?: MonitorAlert;
909
- checkpoint?: MonitorCheckpoint;
910
- /**
911
- * Enable this option if monitor should not be scheduled in maintenance. By default, monitor is scheduled but results are flagged and not used for alerting and SLA calculation.
912
- */
913
- noScheduleOnMaintenance?: boolean | null;
914
- /**
915
- * Enable this option if a failing monitor should not be rescheduled. By default, the monitoring interval is changed to 5 minutes if a monitor starts failing and the interval is longer than 5 minutes. Once the monitor is OK the original interval is restored.
916
- */
917
- noRescheduleOnFailure?: boolean | null;
918
- };
919
- /**
920
- * Class Alert
921
- */
922
- export type MonitorAlert = {
923
- timeWarn?: number;
924
- timePoor?: number;
925
- timeOut?: number;
926
- alertAfter?: -1 | 0 | 1 | 2 | 3 | 4;
927
- /**
928
- * Currently has no effect
929
- */
930
- dontDoPostMortem?: boolean;
931
- contactId?: number | null;
932
- notifyWhenUp?: boolean;
933
- quietPeriod?: '00:10:00' | '00:15:00' | '00:20:00' | '00:30:00' | '01:00:00' | '02:00:00' | '03:00:00' | '06:00:00' | '12:00:00' | '18:00:00' | '24:00:00';
934
- checkThreshold?: 1 | 2 | 3 | 4 | 5;
935
- };
936
- /**
937
- * Class Certificate
938
- */
939
- export type MonitorCertificates = {
940
- /**
941
- * CA certificate or chain for peer verification, either in PKCS12 or PEM format
942
- */
943
- ca?: string;
944
- /**
945
- * Client certificate for authentication, either in PKCS12 or PEM format. Client certificate consists of public (cert) and private (key) parts. Both parts must be included here.
946
- */
947
- client?: string;
948
- clientPassword?: string;
949
- };
950
- /**
951
- * Class Check
952
- */
953
- export type MonitorCheck = {
954
- /**
955
- * Scheduler modes - 0(sequential), 1(multi), 4(sequential asynchronous), 5(multi asynchronous). If unsure, use 0
956
- */
957
- mode?: 0 | 1 | 4 | 5;
958
- interval?: string;
959
- periodFrom?: string;
960
- periodTo?: string;
961
- days?: Array<number>;
962
- };
963
- /**
964
- * Class Checkpoint
965
- */
966
- export type MonitorCheckpoint = {
967
- usePublic?: boolean;
968
- groupIds?: Array<number> | null;
969
- algorithm?: 'master' | 'random' | 'seq' | 'sticky';
970
- defaultGroupId?: number | null;
971
- };
972
- /**
973
- * Common FTP/S monitors' fields
974
- */
975
- export type FtpCommonTrait = {
976
- path?: string;
977
- connectionMode?: 0 | 1 | 2;
978
- };
979
- /**
980
- * Common HTTP/S monitors' fields
981
- */
982
- export type HttpCommonTrait = UrlTrait & ProxyTrait & LoginTrait & MatchStringTrait & IpVersionTrait & RequestHeadersTrait & UserAgentTrait & PostDataTrait & {
983
- /**
984
- * HTTP method. If empty, GET (data is empty) or POST (data is not empty) is used. This value is disregarded on OPMS before 10.7.
985
- */
986
- httpMethod?: '' | 'GET' | 'HEAD' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
987
- acceptedHttpCodes?: string;
988
- avoidCompression?: boolean;
989
- useNtlm?: boolean;
990
- redirectLimit?: number;
991
- };
992
- export type Browser = ProxyTrait & LoginTrait & MatchStringTrait & RequestHeadersTrait & IpVersionTrait & UserAgentTrait & VerifyCertificateTrait & AllowDenyTrait & TransactionPatternsTrait & Monitor & {
993
- url: string;
994
- jsErrorReport?: boolean;
995
- elemErrorReport?: boolean;
996
- toggleQuiescence?: boolean;
997
- postVariables?: string;
998
- };
999
- export type BrowserCreate = ProxyTrait & LoginTrait & MatchStringTrait & RequestHeadersTrait & IpVersionTrait & UserAgentTrait & VerifyCertificateTrait & AllowDenyTrait & TransactionPatternsTrait & MonitorCreate & {
1000
- url: string;
1001
- jsErrorReport?: boolean;
1002
- elemErrorReport?: boolean;
1003
- toggleQuiescence?: boolean;
1004
- postVariables?: string;
1005
- };
1006
- export type BrowserUpdate = ProxyTrait & LoginTrait & MatchStringTrait & RequestHeadersTrait & IpVersionTrait & UserAgentTrait & VerifyCertificateTrait & AllowDenyTrait & TransactionPatternsTrait & MonitorUpdate & {
1007
- url?: string;
1008
- jsErrorReport?: boolean;
1009
- elemErrorReport?: boolean;
1010
- toggleQuiescence?: boolean;
1011
- postVariables?: string;
1012
- };
1013
- export type Connect = HostPortTrait & MatchStringTrait & Monitor;
1014
- export type ConnectCreate = HostPortTrait & MatchStringTrait & MonitorCreate;
1015
- export type ConnectUpdate = HostPortTrait & MatchStringTrait & MonitorUpdate;
1016
- /**
1017
- * Class Dns
1018
- */
1019
- export type Dns = Monitor & {
1020
- domainName: string;
1021
- port: number;
1022
- recordType?: 'A' | 'AAAA' | 'MX' | 'NS' | 'CNAME' | 'PTR' | 'SOA' | 'TXT';
1023
- /**
1024
- * Comma-separated expected RR values. This will be an array in the future
1025
- */
1026
- expectedResult?: string;
1027
- retries?: 0 | 1 | 2 | 3;
1028
- match?: -1 | 0 | 1;
1029
- protocol?: 'tcp' | 'udp';
1030
- target?: string;
1031
- respondThreshold?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
1032
- delimiter?: '' | ',' | '|' | ';' | '#|#' | '#;#' | '#ASM_ITEM_DELIMITER#';
1033
- };
1034
- /**
1035
- * Class Dns
1036
- */
1037
- export type DnsCreate = MonitorCreate & {
1038
- domainName: string;
1039
- port: number;
1040
- recordType?: 'A' | 'AAAA' | 'MX' | 'NS' | 'CNAME' | 'PTR' | 'SOA' | 'TXT';
1041
- /**
1042
- * Comma-separated expected RR values. This will be an array in the future
1043
- */
1044
- expectedResult?: string;
1045
- retries?: 0 | 1 | 2 | 3;
1046
- match?: -1 | 0 | 1;
1047
- protocol?: 'tcp' | 'udp';
1048
- target?: string;
1049
- respondThreshold?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
1050
- delimiter?: '' | ',' | '|' | ';' | '#|#' | '#;#' | '#ASM_ITEM_DELIMITER#';
1051
- };
1052
- /**
1053
- * Class Monitor
1054
- */
1055
- export type DnsUpdate = MonitorUpdate & {
1056
- domainName?: string;
1057
- port?: number;
1058
- recordType?: 'A' | 'AAAA' | 'MX' | 'NS' | 'CNAME' | 'PTR' | 'SOA' | 'TXT';
1059
- /**
1060
- * Comma-separated expected RR values. This will be an array in the future
1061
- */
1062
- expectedResult?: string;
1063
- retries?: 0 | 1 | 2 | 3;
1064
- match?: -1 | 0 | 1;
1065
- protocol?: 'tcp' | 'udp';
1066
- target?: string;
1067
- respondThreshold?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
1068
- delimiter?: '' | ',' | '|' | ';' | '#|#' | '#;#' | '#ASM_ITEM_DELIMITER#';
1069
- };
1070
- export type Dnsa = HostPortTrait & Monitor & {
1071
- path: string;
1072
- maxQueries: number;
1073
- };
1074
- export type DnsaCreate = HostPortTrait & MonitorCreate & {
1075
- path: string;
1076
- maxQueries: number;
1077
- };
1078
- export type DnsaUpdate = HostPortTrait & MonitorUpdate & {
1079
- path?: string;
1080
- maxQueries?: number;
1081
- };
1082
- export type Dnsns = HostPortTrait & Monitor & {
1083
- path: string;
1084
- maxQueries: number;
1085
- };
1086
- export type DnsnsCreate = HostPortTrait & MonitorCreate & {
1087
- path: string;
1088
- maxQueries: number;
1089
- };
1090
- export type DnsnsUpdate = HostPortTrait & MonitorUpdate & {
1091
- path?: string;
1092
- maxQueries?: number;
1093
- };
1094
- /**
1095
- * Class Domain
1096
- */
1097
- export type Domain = Monitor & {
1098
- domainName: string;
1099
- port: number;
1100
- retries: 0 | 1 | 2 | 3;
1101
- protocol: 'tcp' | 'udp';
1102
- target: string;
1103
- respondThreshold: 1 | 2 | 3 | 4 | 5 | 6 | 7;
1104
- doZoneTransfer?: boolean;
1105
- };
1106
- /**
1107
- * Class Domain
1108
- */
1109
- export type DomainCreate = MonitorCreate & {
1110
- domainName: string;
1111
- port: number;
1112
- retries: 0 | 1 | 2 | 3;
1113
- protocol: 'tcp' | 'udp';
1114
- target: string;
1115
- respondThreshold: 1 | 2 | 3 | 4 | 5 | 6 | 7;
1116
- doZoneTransfer?: boolean;
1117
- };
1118
- /**
1119
- * Class Monitor
1120
- */
1121
- export type DomainUpdate = MonitorUpdate & {
1122
- domainName?: string;
1123
- port?: number;
1124
- retries?: 0 | 1 | 2 | 3;
1125
- protocol?: 'tcp' | 'udp';
1126
- target?: string;
1127
- respondThreshold?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
1128
- doZoneTransfer?: boolean;
1129
- };
1130
- /**
1131
- * FTP monitor
1132
- */
1133
- export type Ftp = FtpCommonTrait & HostPortTrait & MatchStringTrait & LoginTrait & IpVersionTrait & Monitor;
1134
- export type FtpCreate = FtpCommonTrait & HostPortTrait & MatchStringTrait & LoginTrait & IpVersionTrait & MonitorCreate;
1135
- export type FtpUpdate = FtpCommonTrait & HostPortTrait & MatchStringTrait & LoginTrait & IpVersionTrait & MonitorUpdate;
1136
- export type Ftps = FtpCommonTrait & HostPortTrait & MatchStringTrait & LoginTrait & IpVersionTrait & Monitor;
1137
- export type FtpsCreate = FtpCommonTrait & HostPortTrait & MatchStringTrait & LoginTrait & IpVersionTrait & MonitorCreate;
1138
- export type FtpsUpdate = FtpCommonTrait & HostPortTrait & MatchStringTrait & LoginTrait & IpVersionTrait & MonitorUpdate;
1139
- /**
1140
- * The definition of HTTP monitor type
1141
- */
1142
- export type Http = HttpCommonTrait & Monitor;
1143
- export type HttpCreate = HttpCommonTrait & MonitorCreate;
1144
- export type HttpUpdate = HttpCommonTrait & MonitorUpdate;
1145
- export type Https = HttpCommonTrait & UseCertificatesTrait & EncryptionTrait & VerifyCertificateTrait & Http;
1146
- export type HttpsCreate = HttpCommonTrait & UseCertificatesTrait & EncryptionTrait & VerifyCertificateTrait & MonitorCreate;
1147
- export type HttpsUpdate = HttpCommonTrait & UseCertificatesTrait & EncryptionTrait & VerifyCertificateTrait & MonitorUpdate;
1148
- export type Imap = HostPortTrait & LoginTrait & VerifyCertificateTrait & Monitor & {
1149
- path?: string;
1150
- sslEncryption?: boolean;
1151
- };
1152
- export type ImapCreate = HostPortTrait & LoginTrait & VerifyCertificateTrait & MonitorCreate & {
1153
- path?: string;
1154
- sslEncryption?: boolean;
1155
- };
1156
- export type ImapUpdate = HostPortTrait & LoginTrait & VerifyCertificateTrait & MonitorUpdate & {
1157
- path?: string;
1158
- sslEncryption?: boolean;
1159
- };
1160
- export type Ldap = HostPortTrait & LoginTrait & MatchStringTrait & IpVersionTrait & VerifyCertificateTrait & Monitor & {
1161
- /**
1162
- * The search base and filter. Spaces in the filter must be replaced with %20
1163
- */
1164
- path?: string;
1165
- sslEncryption?: boolean;
1166
- };
1167
- export type LdapCreate = HostPortTrait & LoginTrait & MatchStringTrait & IpVersionTrait & VerifyCertificateTrait & MonitorCreate & {
1168
- /**
1169
- * The search base and filter. Spaces in the filter must be replaced with %20
1170
- */
1171
- path?: string;
1172
- sslEncryption?: boolean;
1173
- };
1174
- export type LdapUpdate = HostPortTrait & LoginTrait & MatchStringTrait & IpVersionTrait & VerifyCertificateTrait & MonitorUpdate & {
1175
- /**
1176
- * The search base and filter. Spaces in the filter must be replaced with %20
1177
- */
1178
- path?: string;
1179
- sslEncryption?: boolean;
1180
- };
1181
- export type Ping = IpVersionTrait & Monitor & {
1182
- host: string;
1183
- /**
1184
- * Packet loss in % (1-100)
1185
- */
1186
- packetLossThreshold: number;
1187
- };
1188
- export type PingCreate = IpVersionTrait & MonitorCreate & {
1189
- host: string;
1190
- /**
1191
- * Packet loss in % (1-100)
1192
- */
1193
- packetLossThreshold: number;
1194
- };
1195
- export type PingUpdate = IpVersionTrait & MonitorUpdate & {
1196
- host?: string;
1197
- /**
1198
- * Packet loss in % (1-100)
1199
- */
1200
- packetLossThreshold?: number;
1201
- };
1202
- export type Plugin = UrlTrait & LoginTrait & Monitor & {
1203
- parameters?: string;
1204
- };
1205
- export type PluginCreate = UrlTrait & LoginTrait & MonitorCreate & {
1206
- parameters?: string;
1207
- };
1208
- export type PluginUpdate = UrlTrait & LoginTrait & MonitorUpdate & {
1209
- parameters?: string;
1210
- };
1211
- export type Pop3 = HostPortTrait & LoginTrait & VerifyCertificateTrait & Monitor & {
1212
- sslEncryption?: boolean;
1213
- };
1214
- export type Pop3Create = HostPortTrait & LoginTrait & VerifyCertificateTrait & MonitorCreate & {
1215
- sslEncryption?: boolean;
1216
- };
1217
- export type Pop3Update = HostPortTrait & LoginTrait & VerifyCertificateTrait & MonitorUpdate & {
1218
- sslEncryption?: boolean;
1219
- };
1220
- export type Scp = HostPortTrait & LoginTrait & MatchStringTrait & IpVersionTrait & Monitor & {
1221
- path?: string;
1222
- };
1223
- export type ScpCreate = HostPortTrait & LoginTrait & MatchStringTrait & IpVersionTrait & MonitorCreate & {
1224
- path?: string;
1225
- };
1226
- export type ScpUpdate = HostPortTrait & LoginTrait & MatchStringTrait & IpVersionTrait & MonitorUpdate & {
1227
- path?: string;
1228
- };
1229
- export type Script = UseCertificatesTrait & ProxyTrait & LoginTrait & Monitor & {
1230
- host: string;
1231
- port: number;
1232
- path?: string;
1233
- encryption?: 'tls' | 'tlsv1.0' | 'tlsv1.1' | 'tlsv1.2' | 'sslv3';
1234
- assertOnly?: boolean;
1235
- responseContent?: boolean;
1236
- scriptFile?: MonitorScript;
1237
- };
1238
- export type ScriptCreate = UseCertificatesTrait & ProxyTrait & LoginTrait & MonitorCreate & {
1239
- host?: string;
1240
- port?: number;
1241
- path?: string;
1242
- encryption?: 'tls' | 'tlsv1.0' | 'tlsv1.1' | 'tlsv1.2' | 'sslv3';
1243
- assertOnly?: boolean;
1244
- responseContent?: boolean;
1245
- scriptFile?: MonitorScriptCreate | {
1246
- [key: string]: unknown;
1247
- } | null;
1248
- };
1249
- export type ScriptUpdate = UseCertificatesTrait & ProxyTrait & LoginTrait & MonitorUpdate & {
1250
- host?: string;
1251
- port?: number;
1252
- path?: string;
1253
- encryption?: 'tls' | 'tlsv1.0' | 'tlsv1.1' | 'tlsv1.2' | 'sslv3';
1254
- assertOnly?: boolean;
1255
- responseContent?: boolean;
1256
- scriptFile?: MonitorScriptCreate | {
1257
- [key: string]: unknown;
1258
- } | null;
1259
- };
1260
- export type Sftp = HostPortTrait & LoginTrait & MatchStringTrait & IpVersionTrait & Monitor & {
1261
- path?: string;
1262
- };
1263
- export type SftpCreate = HostPortTrait & LoginTrait & MatchStringTrait & IpVersionTrait & MonitorCreate & {
1264
- path?: string;
1265
- };
1266
- export type SftpUpdate = HostPortTrait & LoginTrait & MatchStringTrait & IpVersionTrait & MonitorUpdate & {
1267
- path?: string;
1268
- };
1269
- export type Sip = HostPortTrait & Monitor;
1270
- export type SipCreate = HostPortTrait & MonitorCreate;
1271
- export type SipUpdate = HostPortTrait & MonitorUpdate;
1272
- export type Smtp = HostPortTrait & Monitor;
1273
- export type SmtpCreate = HostPortTrait & MonitorCreate;
1274
- export type SmtpUpdate = HostPortTrait & MonitorUpdate;
1275
- export type Telnet = HostPortTrait & Monitor;
1276
- export type TelnetCreate = HostPortTrait & MonitorCreate;
1277
- export type TelnetUpdate = HostPortTrait & MonitorUpdate;
1278
- /**
1279
- * TLS monitor for server certificate monitoring
1280
- */
1281
- export type Tls = HostPortTrait & UseCertificatesTrait & ProxyTrait & IpVersionTrait & EncryptionTrait & Monitor & {
1282
- expirationShift?: number;
1283
- };
1284
- export type TlsCreate = HostPortTrait & UseCertificatesTrait & ProxyTrait & IpVersionTrait & EncryptionTrait & MonitorCreate & {
1285
- expirationShift?: number;
1286
- };
1287
- export type TlsUpdate = HostPortTrait & UseCertificatesTrait & ProxyTrait & IpVersionTrait & EncryptionTrait & MonitorUpdate & {
1288
- expirationShift?: number;
1289
- };
1290
- export type Webdriver = ProxyTrait & UseCertificatesTrait & LoginTrait & UserAgentTrait & VerifyCertificateTrait & AllowDenyTrait & TransactionPatternsTrait & Monitor & {
1291
- host?: string;
1292
- elemErrorReport?: boolean;
1293
- toggleQuiescence?: boolean;
1294
- /**
1295
- * Enable this option if monitor is monitoring page leveraging additionaly the browser agent and webdriver is expected to wait for the browser agent to send the metrics before executing the next step. Do not enable it unless you know what you are doing. If browser is NOT present and this value is enabled, monitor will timeout on the first step waiting for browser agent confirmation.
1296
- */
1297
- browserAgent?: boolean | null;
1298
- proxyExcludeHosts?: string;
1299
- /**
1300
- * Comma-separated, colon-separated domain pairs. This will be an array in the future
1301
- */
1302
- remapHosts?: string;
1303
- blockHtml5Media?: boolean;
1304
- browser?: string;
1305
- authenticationType?: string;
1306
- scriptFile?: MonitorScript;
1307
- };
1308
- export type WebdriverCreate = ProxyTrait & UseCertificatesTrait & LoginTrait & UserAgentTrait & VerifyCertificateTrait & AllowDenyTrait & TransactionPatternsTrait & MonitorCreate & {
1309
- host?: string;
1310
- elemErrorReport?: boolean;
1311
- toggleQuiescence?: boolean;
1312
- /**
1313
- * Enable this option if monitor is monitoring page leveraging additionaly the browser agent and webdriver is expected to wait for the browser agent to send the metrics before executing the next step. Do not enable it unless you know what you are doing. If browser is NOT present and this value is enabled, monitor will timeout on the first step waiting for browser agent confirmation.
1314
- */
1315
- browserAgent?: boolean | null;
1316
- proxyExcludeHosts?: string;
1317
- /**
1318
- * Comma-separated, colon-separated domain pairs. This will be an array in the future
1319
- */
1320
- remapHosts?: string;
1321
- blockHtml5Media?: boolean;
1322
- browser?: string;
1323
- authenticationType?: string;
1324
- scriptFile?: MonitorScriptCreate | {
1325
- [key: string]: unknown;
1326
- } | null;
1327
- };
1328
- export type WebdriverUpdate = ProxyTrait & UseCertificatesTrait & LoginTrait & UserAgentTrait & VerifyCertificateTrait & AllowDenyTrait & TransactionPatternsTrait & MonitorUpdate & {
1329
- host?: string;
1330
- elemErrorReport?: boolean;
1331
- toggleQuiescence?: boolean;
1332
- /**
1333
- * Enable this option if monitor is monitoring page leveraging additionaly the browser agent and webdriver is expected to wait for the browser agent to send the metrics before executing the next step. Do not enable it unless you know what you are doing. If browser is NOT present and this value is enabled, monitor will timeout on the first step waiting for browser agent confirmation.
1334
- */
1335
- browserAgent?: boolean | null;
1336
- proxyExcludeHosts?: string;
1337
- /**
1338
- * Comma-separated, colon-separated domain pairs. This will be an array in the future
1339
- */
1340
- remapHosts?: string;
1341
- blockHtml5Media?: boolean;
1342
- browser?: string;
1343
- authenticationType?: string;
1344
- scriptFile?: MonitorScriptCreate | {
1345
- [key: string]: unknown;
1346
- } | null;
1347
- };
1348
- export type Websocket = UrlTrait & ProxyTrait & UseCertificatesTrait & VerifyCertificateTrait & LoginTrait & MatchStringTrait & IpVersionTrait & PostDataTrait & RequestHeadersTrait & UserAgentTrait & Monitor & {
1349
- healthCheck?: boolean;
1350
- idleDelay?: number;
1351
- };
1352
- export type WebsocketCreate = UrlTrait & ProxyTrait & UseCertificatesTrait & VerifyCertificateTrait & LoginTrait & MatchStringTrait & IpVersionTrait & PostDataTrait & RequestHeadersTrait & UserAgentTrait & MonitorCreate & {
1353
- healthCheck?: boolean;
1354
- idleDelay?: number;
1355
- };
1356
- export type WebsocketUpdate = UrlTrait & ProxyTrait & UseCertificatesTrait & VerifyCertificateTrait & LoginTrait & MatchStringTrait & IpVersionTrait & PostDataTrait & RequestHeadersTrait & UserAgentTrait & MonitorUpdate & {
1357
- healthCheck?: boolean;
1358
- idleDelay?: number;
1359
- };
1360
- /**
1361
- * Class MonitorFrame
1362
- * This schema is used in the APIv3 to get list of monitors when the performance matters.
1363
- * To retrieve full list of monitor properties lots of per-monitor queries must be executed which is time consuming (e.g. maintenance status).
1364
- * This schema contains only parameters that needs no extra queries and/or lengthy calculations.
1365
- * These parameters should be sufficient to get list of monitors for charts, selection dropboxes etc.
1366
- */
1367
- export type MonitorFrame = {
1368
- id?: number;
1369
- /**
1370
- * The monitor type.
1371
- */
1372
- type?: 'http' | 'https' | 'connect' | 'dns' | 'dnsa' | 'dnsns' | 'domain' | 'ftp' | 'ftps' | 'imap' | 'ldap' | 'ping' | 'plugin' | 'pop3' | 'scp' | 'sftp' | 'sip' | 'smtp' | 'telnet' | 'browser' | 'script';
1373
- name?: string;
1374
- folderId?: number;
1375
- /**
1376
- * Status of the monitor (read only). The status of the folder is not reflected.
1377
- */
1378
- status?: 'deleted' | 'inactive' | 'active' | 'unconfirmed' | 'locked' | 'error';
1379
- /**
1380
- * Health status of the monitoring station pool (read only). This flag is true if the number of monitoring stations in insufficient.
1381
- */
1382
- unhealthy?: boolean | null;
1383
- };
1384
- /**
1385
- * Class ScriptFile
1386
- */
1387
- export type MonitorScript = MonitorScriptCreate & {
1388
- /**
1389
- * ID of the script
1390
- */
1391
- scriptId?: number;
1392
- content?: string | null;
1393
- };
1394
- /**
1395
- * Class ScriptFileCreate
1396
- */
1397
- export type MonitorScriptCreate = {
1398
- /**
1399
- * If you want to reuse a previously uploaded script, send this ID but not the new script content. This feature is deprecated, will be removed in the future releases without notice.
1400
- */
1401
- scriptId?: number | null;
1402
- contentArchive?: string | null;
1403
- parameters?: string | null;
1404
- stages?: string | null;
1405
- };
1406
- export type MonitorTag = {
1407
- id?: number;
1408
- name?: string;
1409
- };
1410
- export type EventAsset = {
1411
- url?: string;
1412
- type?: 'jtl' | 'har' | 'http' | 'image' | 'video' | 'log' | 'console_log';
1413
- };
1414
- export type LogEvent = {
1415
- id?: string;
1416
- monitor?: StatisticResource;
1417
- location?: StatisticResource;
1418
- folder?: StatisticResource;
1419
- start?: string;
1420
- duration?: number;
1421
- interval?: number;
1422
- monitor_type?: string;
1423
- result?: EventResult;
1424
- metrics?: LogEventMetrics;
1425
- assets?: Array<EventAsset> | null;
1426
- probeMetrics?: ProbeMetrics | {
1427
- [key: string]: unknown;
1428
- } | null;
1429
- };
1430
- export type LogEventMetrics = {
1431
- /**
1432
- * Resolve time (ms)
1433
- */
1434
- rtime?: number;
1435
- /**
1436
- * Connect time (ms)
1437
- */
1438
- ctime?: number;
1439
- /**
1440
- * First byte time (ms)
1441
- */
1442
- ptime?: number;
1443
- /**
1444
- * Download time (ms)
1445
- */
1446
- dtime?: number;
1447
- /**
1448
- * User interaction time (ms)
1449
- */
1450
- utime?: number;
1451
- /**
1452
- * Download size (bytes)
1453
- */
1454
- dsize?: number;
1455
- /**
1456
- * Number of multi-check probes performed, including internal errors
1457
- */
1458
- multi_probes_all?: number;
1459
- /**
1460
- * Number of multi-check probes performed, excluding internal errors
1461
- */
1462
- multi_probes?: number;
1463
- /**
1464
- * Number of multi-check probes failed, excluding internal errors
1465
- */
1466
- multi_probes_failed?: number;
1467
- };
1468
- export type MetricResource = {
1469
- probes?: number;
1470
- probe_ok?: number;
1471
- probe_errors?: number;
1472
- checks?: number;
1473
- check_errors?: number;
1474
- checks_maint?: number;
1475
- maint_errors?: number;
1476
- rtime?: number;
1477
- ctime?: number;
1478
- ptime?: number;
1479
- utime?: number;
1480
- dtime?: number;
1481
- rtime_ok?: number;
1482
- ctime_ok?: number;
1483
- ptime_ok?: number;
1484
- utime_ok?: number;
1485
- dtime_ok?: number;
1486
- dsize?: number;
1487
- dev_rtime?: number;
1488
- dev_ctime?: number;
1489
- dev_ptime?: number;
1490
- dev_utime?: number;
1491
- dev_dtime?: number;
1492
- dev_dsize?: number;
1493
- xtime?: number;
1494
- xtime_ok?: number;
1495
- xspeed?: number;
1496
- upstatus?: number;
1497
- perfstatus?: number;
1498
- score?: number;
1499
- spi_score?: number;
1500
- spi_penalty?: number;
1501
- uptime?: number;
1502
- downtime?: number;
1503
- ttime?: number;
1504
- ttime_ok?: number;
1505
- dspeed?: number;
1506
- slawarn?: number;
1507
- slapoor?: number;
1508
- apdex?: number;
1509
- };
1510
- export type ProbeMetrics = {
1511
- id?: string;
1512
- startTime?: string;
1513
- duration?: number;
1514
- failed?: boolean | null;
1515
- statusCode?: number | null;
1516
- statusString?: string | null;
1517
- domain?: string | null;
1518
- performance?: 'good' | 'poor' | 'bad';
1519
- metrics?: StageMetrics;
1520
- stages?: Array<Stage>;
1521
- };
1522
- export type EventResult = {
1523
- code?: number;
1524
- description?: string;
1525
- type?: 'ok' | 'unconfirmed_error' | 'confirmed_error' | 'maintenance' | 'unscheduled';
1526
- /**
1527
- * For successful checks this value is calculated based on total time and monitor thresholds
1528
- */
1529
- performance?: 'good' | 'poor' | 'bad';
1530
- };
1531
- export type Stage = {
1532
- name?: string;
1533
- startTime?: string;
1534
- duration?: number;
1535
- failed?: boolean | null;
1536
- statusCode?: number | null;
1537
- statusString?: string | null;
1538
- CorID?: string | null;
1539
- metrics?: StageMetrics;
1540
- transactions?: Array<Transaction>;
1541
- };
1542
- export type StageMetrics = {
1543
- /**
1544
- * Time spent in HTTP client's queue before starting the request (ms)
1545
- */
1546
- blocked?: number | null;
1547
- /**
1548
- * Time spent on the TLS handshake (ms)
1549
- */
1550
- tls?: number | null;
1551
- /**
1552
- * Time spent on resolution of the IP address from the URI (ms)
1553
- */
1554
- dns?: number | null;
1555
- /**
1556
- * Time spent on establishing connection to the monitored service (ms)
1557
- */
1558
- connect?: number | null;
1559
- /**
1560
- * Time spent on sending request (ms)
1561
- */
1562
- upload?: number | null;
1563
- /**
1564
- * Time since upload was completed until the server starts sending response (ms)
1565
- */
1566
- firstByte?: number | null;
1567
- /**
1568
- * Time spent on receiving response (ms)
1569
- */
1570
- download?: number | null;
1571
- /**
1572
- * Size of request, including headers (bytes)
1573
- */
1574
- uploadSize?: number | null;
1575
- /**
1576
- * Size of response, including headers (bytes)
1577
- */
1578
- downloadSize?: number | null;
1579
- /**
1580
- * Size of request headers (bytes)
1581
- */
1582
- uploadHeadersSize?: number | null;
1583
- /**
1584
- * Size of response headers (bytes)
1585
- */
1586
- downloadHeadersSize?: number | null;
1587
- /**
1588
- * Time since start of the stage until the onContentLoad event (ms)
1589
- */
1590
- onContentLoad?: number | null;
1591
- /**
1592
- * Time since start of the stage until the onLoad event (ms)
1593
- */
1594
- onLoad?: number | null;
1595
- /**
1596
- * Number of transactions in this stage
1597
- */
1598
- requestCount?: number | null;
1599
- /**
1600
- * Number of failed transactions
1601
- */
1602
- failedCount?: number | null;
1603
- /**
1604
- * Time spent executing transactions (ms)
1605
- */
1606
- totalTime?: number | null;
1607
- /**
1608
- * Number of HTTP redirects
1609
- */
1610
- redirectCount?: number | null;
1611
- /**
1612
- * Total time spent on HTTP redirects
1613
- */
1614
- redirectTime?: number | null;
1615
- };
1616
- export type StatisticItem = {
1617
- timestamp: string;
1618
- monitors: Array<StatisticResource>;
1619
- locations: Array<StatisticResource>;
1620
- metrics?: MetricResource;
1621
- };
1622
- export type StatisticResource = {
1623
- id: number;
1624
- name: string;
1625
- };
1626
- export type Transaction = {
1627
- /**
1628
- * URI of the monitored service
1629
- */
1630
- uri?: string;
1631
- /**
1632
- * IP address of the monitored service
1633
- */
1634
- serverIp?: string;
1635
- startTime?: string;
1636
- duration?: number;
1637
- failed?: boolean | null;
1638
- statusCode?: number | null;
1639
- statusString?: string | null;
1640
- metrics?: TransactionMetrics;
1641
- };
1642
- export type TransactionMetrics = {
1643
- /**
1644
- * Time spent in HTTP client's queue before starting the request (ms)
1645
- */
1646
- blocked?: number | null;
1647
- /**
1648
- * Time spent on the TLS handshake (ms)
1649
- */
1650
- tls?: number | null;
1651
- /**
1652
- * Time spent on resolution of the IP address from the URI (ms)
1653
- */
1654
- dns?: number | null;
1655
- /**
1656
- * Time spent on establishing connection to the monitored service (ms)
1657
- */
1658
- connect?: number | null;
1659
- /**
1660
- * Time spent on sending request (ms)
1661
- */
1662
- upload?: number | null;
1663
- /**
1664
- * Time since upload was completed until the server starts sending response (ms)
1665
- */
1666
- firstByte?: number | null;
1667
- /**
1668
- * Time spent on receiving response (ms)
1669
- */
1670
- download?: number | null;
1671
- /**
1672
- * Size of request, including headers (bytes)
1673
- */
1674
- uploadSize?: number | null;
1675
- /**
1676
- * Size of response, including headers (bytes)
1677
- */
1678
- downloadSize?: number | null;
1679
- /**
1680
- * Size of request headers (bytes)
1681
- */
1682
- uploadHeadersSize?: number | null;
1683
- /**
1684
- * Size of response headers (bytes)
1685
- */
1686
- downloadHeadersSize?: number | null;
1687
- };
1688
- export type ApiTokenListData = {
1689
- body?: never;
1690
- path?: never;
1691
- query?: never;
1692
- url: '/api-token';
1693
- };
1694
- export type ApiTokenListErrors = {
1695
- /**
1696
- * Not permitted to access
1697
- */
1698
- 403: Forbidden;
1699
- };
1700
- export type ApiTokenListError = ApiTokenListErrors[keyof ApiTokenListErrors];
1701
- export type ApiTokenListResponses = {
1702
- /**
1703
- * Success
1704
- */
1705
- 200: Array<ApiToken>;
1706
- };
1707
- export type ApiTokenListResponse = ApiTokenListResponses[keyof ApiTokenListResponses];
1708
- export type ApiTokenCreateData = {
1709
- body: {
1710
- name?: string;
1711
- valid_until?: string;
1712
- };
1713
- path?: never;
1714
- query?: never;
1715
- url: '/api-token';
1716
- };
1717
- export type ApiTokenCreateErrors = {
1718
- /**
1719
- * Not permitted to access
1720
- */
1721
- 403: Forbidden;
1722
- };
1723
- export type ApiTokenCreateError = ApiTokenCreateErrors[keyof ApiTokenCreateErrors];
1724
- export type ApiTokenCreateResponses = {
1725
- /**
1726
- * Success
1727
- */
1728
- 201: {
1729
- status?: string;
1730
- data?: {
1731
- id?: number;
1732
- name?: string;
1733
- token?: string;
1734
- valid_until?: string;
1735
- };
1736
- };
1737
- };
1738
- export type ApiTokenCreateResponse = ApiTokenCreateResponses[keyof ApiTokenCreateResponses];
1739
- export type ApiTokenDeleteData = {
1740
- body?: never;
1741
- path: {
1742
- /**
1743
- * The ID of the token to delete
1744
- */
1745
- id: number;
1746
- };
1747
- query?: never;
1748
- url: '/api-token/{id}';
1749
- };
1750
- export type ApiTokenDeleteErrors = {
1751
- /**
1752
- * Not permitted to access
1753
- */
1754
- 403: Forbidden;
1755
- /**
1756
- * Token not found
1757
- */
1758
- 404: ApiTokenNotFound;
1759
- };
1760
- export type ApiTokenDeleteError = ApiTokenDeleteErrors[keyof ApiTokenDeleteErrors];
1761
- export type ApiTokenDeleteResponses = {
1762
- /**
1763
- * Success
1764
- */
1765
- 200: {
1766
- message?: string;
1767
- };
1768
- };
1769
- export type ApiTokenDeleteResponse = ApiTokenDeleteResponses[keyof ApiTokenDeleteResponses];
1770
- export type ApiTokenGetData = {
1771
- body?: never;
1772
- path: {
1773
- /**
1774
- * Token ID
1775
- */
1776
- id: number;
1777
- };
1778
- query?: never;
1779
- url: '/api-token/{id}';
1780
- };
1781
- export type ApiTokenGetErrors = {
1782
- /**
1783
- * Not permitted to access
1784
- */
1785
- 403: Forbidden;
1786
- /**
1787
- * Token not found
1788
- */
1789
- 404: ApiTokenNotFound;
1790
- };
1791
- export type ApiTokenGetError = ApiTokenGetErrors[keyof ApiTokenGetErrors];
1792
- export type ApiTokenGetResponses = {
1793
- /**
1794
- * Success
1795
- */
1796
- 200: ApiToken;
1797
- };
1798
- export type ApiTokenGetResponse = ApiTokenGetResponses[keyof ApiTokenGetResponses];
1799
- export type ApiTokenUpdateData = {
1800
- /**
1801
- * The request body for updating token. Name is mandatory, valid_until is optional and defaults to null (valid indefinitely), can be any valid datetime string.
1802
- */
1803
- body: {
1804
- name?: string;
1805
- valid_until?: string;
1806
- };
1807
- path: {
1808
- /**
1809
- * The ID of the item to update
1810
- */
1811
- id: number;
1812
- };
1813
- query?: never;
1814
- url: '/api-token/{id}';
1815
- };
1816
- export type ApiTokenUpdateErrors = {
1817
- /**
1818
- * Not permitted to access
1819
- */
1820
- 403: Forbidden;
1821
- /**
1822
- * Token not found
1823
- */
1824
- 404: ApiTokenNotFound;
1825
- };
1826
- export type ApiTokenUpdateError = ApiTokenUpdateErrors[keyof ApiTokenUpdateErrors];
1827
- export type ApiTokenUpdateResponses = {
1828
- /**
1829
- * Success
1830
- */
1831
- 200: {
1832
- message?: string;
1833
- data?: ApiToken;
1834
- };
1835
- };
1836
- export type ApiTokenUpdateResponse = ApiTokenUpdateResponses[keyof ApiTokenUpdateResponses];
1837
- export type CheckGetData = {
1838
- body?: never;
1839
- path: {
1840
- /**
1841
- * Monitor ID.
1842
- */
1843
- monitor: string;
1844
- };
1845
- query?: never;
1846
- url: '/check/{monitor}';
1847
- };
1848
- export type CheckGetErrors = {
1849
- /**
1850
- * No subscription available to run this monitor.
1851
- */
1852
- 402: {
1853
- message?: string;
1854
- };
1855
- /**
1856
- * Access to the monitor denied.
1857
- */
1858
- 403: {
1859
- message?: string;
1860
- };
1861
- /**
1862
- * Monitor not found.
1863
- */
1864
- 404: {
1865
- message?: string;
1866
- };
1867
- /**
1868
- * Check executed too soon, try again later
1869
- */
1870
- 429: {
1871
- message?: string;
1872
- };
1873
- /**
1874
- * Other error
1875
- */
1876
- 500: {
1877
- message?: string;
1878
- };
1879
- /**
1880
- * Temporary error, try again later
1881
- */
1882
- 503: {
1883
- message?: string;
1884
- };
1885
- };
1886
- export type CheckGetError = CheckGetErrors[keyof CheckGetErrors];
1887
- export type CheckGetResponses = {
1888
- /**
1889
- * Success
1890
- */
1891
- 200: LogEvent;
1892
- };
1893
- export type CheckGetResponse = CheckGetResponses[keyof CheckGetResponses];
1894
- export type ContactsGetData = {
1895
- body?: never;
1896
- path?: never;
1897
- query?: never;
1898
- url: '/contacts';
1899
- };
1900
- export type ContactsGetErrors = {
1901
- /**
1902
- * Access to the resource was denied.
1903
- */
1904
- 403: {
1905
- message?: string;
1906
- };
1907
- };
1908
- export type ContactsGetError = ContactsGetErrors[keyof ContactsGetErrors];
1909
- export type ContactsGetResponses = {
1910
- /**
1911
- * Success
1912
- */
1913
- 200: ContactCatalogue;
1914
- };
1915
- export type ContactsGetResponse = ContactsGetResponses[keyof ContactsGetResponses];
1916
- export type ContactsCreateData = {
1917
- body?: ContactItemCreate;
1918
- path?: never;
1919
- query?: never;
1920
- url: '/contacts';
1921
- };
1922
- export type ContactsCreateErrors = {
1923
- /**
1924
- * Unsupported contact type
1925
- */
1926
- 400: {
1927
- message?: string;
1928
- };
1929
- /**
1930
- * You don't have permission to create a contact in this folder
1931
- */
1932
- 403: {
1933
- message?: string;
1934
- };
1935
- };
1936
- export type ContactsCreateError = ContactsCreateErrors[keyof ContactsCreateErrors];
1937
- export type ContactsCreateResponses = {
1938
- /**
1939
- * Success
1940
- */
1941
- 201: ContactItem;
1942
- };
1943
- export type ContactsCreateResponse = ContactsCreateResponses[keyof ContactsCreateResponses];
1944
- export type ContactDeleteData = {
1945
- body?: never;
1946
- path: {
1947
- /**
1948
- * Contact id
1949
- */
1950
- id: number;
1951
- };
1952
- query?: never;
1953
- url: '/contacts/{id}';
1954
- };
1955
- export type ContactDeleteErrors = {
1956
- /**
1957
- * The channel is used for alerting.
1958
- */
1959
- 400: {
1960
- message?: string;
1961
- };
1962
- /**
1963
- * Access to the contact was denied.
1964
- */
1965
- 403: {
1966
- message?: string;
1967
- };
1968
- /**
1969
- * Contact not found or or insufficient privileges
1970
- */
1971
- 404: {
1972
- message?: string;
1973
- };
1974
- };
1975
- export type ContactDeleteError = ContactDeleteErrors[keyof ContactDeleteErrors];
1976
- export type ContactDeleteResponses = {
1977
- /**
1978
- * Success
1979
- */
1980
- 204: void;
1981
- };
1982
- export type ContactDeleteResponse = ContactDeleteResponses[keyof ContactDeleteResponses];
1983
- export type ContactsGetDetailData = {
1984
- body?: never;
1985
- path: {
1986
- /**
1987
- * The ID of the contact
1988
- */
1989
- id: number;
1990
- };
1991
- query?: never;
1992
- url: '/contacts/{id}';
1993
- };
1994
- export type ContactsGetDetailErrors = {
1995
- /**
1996
- * Access to the contact was denied.
1997
- */
1998
- 403: {
1999
- message?: string;
2000
- };
2001
- /**
2002
- * Contact not found or or insufficient privileges
2003
- */
2004
- 404: {
2005
- message?: string;
2006
- };
2007
- };
2008
- export type ContactsGetDetailError = ContactsGetDetailErrors[keyof ContactsGetDetailErrors];
2009
- export type ContactsGetDetailResponses = {
2010
- /**
2011
- * Success
2012
- */
2013
- 200: ContactItem;
2014
- };
2015
- export type ContactsGetDetailResponse = ContactsGetDetailResponses[keyof ContactsGetDetailResponses];
2016
- export type ContactsUpdateData = {
2017
- body?: ContactItemUpdate;
2018
- path: {
2019
- /**
2020
- * The ID of the contact
2021
- */
2022
- id: number;
2023
- };
2024
- query?: never;
2025
- url: '/contacts/{id}';
2026
- };
2027
- export type ContactsUpdateErrors = {
2028
- /**
2029
- * Email address is not valid
2030
- */
2031
- 400: {
2032
- message?: string;
2033
- };
2034
- /**
2035
- * Insufficient privileges to update the contact
2036
- */
2037
- 403: {
2038
- message?: string;
2039
- };
2040
- /**
2041
- * Contact not found or or insufficient privileges
2042
- */
2043
- 404: {
2044
- message?: string;
2045
- };
2046
- };
2047
- export type ContactsUpdateError = ContactsUpdateErrors[keyof ContactsUpdateErrors];
2048
- export type ContactsUpdateResponses = {
2049
- /**
2050
- * Success
2051
- */
2052
- 200: ContactItem;
2053
- };
2054
- export type ContactsUpdateResponse = ContactsUpdateResponses[keyof ContactsUpdateResponses];
2055
- export type ContactTestSendData = {
2056
- body?: never;
2057
- path: {
2058
- /**
2059
- * Contact id
2060
- */
2061
- id: number;
2062
- };
2063
- query?: never;
2064
- url: '/contacts/test/{id}';
2065
- };
2066
- export type ContactTestSendErrors = {
2067
- /**
2068
- * Contact has invalid status for sending a test message
2069
- */
2070
- 400: {
2071
- message?: string;
2072
- };
2073
- /**
2074
- * Access to the contact was denied.
2075
- */
2076
- 403: {
2077
- message?: string;
2078
- };
2079
- /**
2080
- * Contact not found or or insufficient privileges
2081
- */
2082
- 404: {
2083
- message?: string;
2084
- };
2085
- /**
2086
- * Message not sent
2087
- */
2088
- 409: {
2089
- message?: string;
2090
- };
2091
- /**
2092
- * Max number of test messages per day already sent
2093
- */
2094
- 429: {
2095
- message?: string;
2096
- };
2097
- };
2098
- export type ContactTestSendError = ContactTestSendErrors[keyof ContactTestSendErrors];
2099
- export type ContactTestSendResponses = {
2100
- /**
2101
- * Success
2102
- */
2103
- 200: {
2104
- message?: string;
2105
- };
2106
- };
2107
- export type ContactTestSendResponse = ContactTestSendResponses[keyof ContactTestSendResponses];
2108
- export type ContactActivateData = {
2109
- body?: never;
2110
- path: {
2111
- /**
2112
- * ID of the contact to activate
2113
- */
2114
- id: number;
2115
- };
2116
- query?: never;
2117
- url: '/contacts/{id}/activate';
2118
- };
2119
- export type ContactActivateErrors = {
2120
- /**
2121
- * The contact is not in inactive status, cannot be activated
2122
- */
2123
- 400: {
2124
- message?: string;
2125
- };
2126
- /**
2127
- * Access to the contact was denied.
2128
- */
2129
- 403: {
2130
- message?: string;
2131
- };
2132
- /**
2133
- * Contact not found or or insufficient privileges
2134
- */
2135
- 404: {
2136
- message?: string;
2137
- };
2138
- };
2139
- export type ContactActivateError = ContactActivateErrors[keyof ContactActivateErrors];
2140
- export type ContactActivateResponses = {
2141
- /**
2142
- * Success
2143
- */
2144
- 204: void;
2145
- };
2146
- export type ContactActivateResponse = ContactActivateResponses[keyof ContactActivateResponses];
2147
- export type ContactsConfirmData = {
2148
- /**
2149
- * The code to activate the contact is sent in request body
2150
- */
2151
- body?: {
2152
- code?: string;
2153
- };
2154
- path: {
2155
- /**
2156
- * The contact ID
2157
- */
2158
- id: number;
2159
- };
2160
- query?: never;
2161
- url: '/contacts/confirm/{id}';
2162
- };
2163
- export type ContactsConfirmErrors = {
2164
- /**
2165
- * The confirmation code is missing
2166
- */
2167
- 400: {
2168
- message?: string;
2169
- };
2170
- /**
2171
- * The confirmation code is invalid
2172
- */
2173
- 403: {
2174
- message?: string;
2175
- };
2176
- /**
2177
- * Contact not found or or insufficient privileges
2178
- */
2179
- 404: {
2180
- message?: string;
2181
- };
2182
- /**
2183
- * The contact is not waiting for confirmation
2184
- */
2185
- 409: {
2186
- message?: string;
2187
- };
2188
- };
2189
- export type ContactsConfirmError = ContactsConfirmErrors[keyof ContactsConfirmErrors];
2190
- export type ContactsConfirmResponses = {
2191
- /**
2192
- * Success
2193
- */
2194
- 204: void;
2195
- };
2196
- export type ContactsConfirmResponse = ContactsConfirmResponses[keyof ContactsConfirmResponses];
2197
- export type ContactsRequestConfirmationCodeData = {
2198
- body?: never;
2199
- path: {
2200
- /**
2201
- * The ID of the contact
2202
- */
2203
- id: number;
2204
- };
2205
- query?: never;
2206
- url: '/contacts/request-confirmation-code/{id}';
2207
- };
2208
- export type ContactsRequestConfirmationCodeErrors = {
2209
- /**
2210
- * This contact type does not support confirmation codes
2211
- */
2212
- 400: {
2213
- message?: string;
2214
- };
2215
- /**
2216
- * Access to the contact was denied.
2217
- */
2218
- 403: {
2219
- message?: string;
2220
- };
2221
- /**
2222
- * Contact not found or or insufficient privileges
2223
- */
2224
- 404: {
2225
- message?: string;
2226
- };
2227
- /**
2228
- * The contact is not waiting for confirmation
2229
- */
2230
- 409: {
2231
- message?: string;
2232
- };
2233
- /**
2234
- * You can request a confirmation code for one contact once every 300 seconds
2235
- */
2236
- 429: {
2237
- message?: string;
2238
- };
2239
- };
2240
- export type ContactsRequestConfirmationCodeError = ContactsRequestConfirmationCodeErrors[keyof ContactsRequestConfirmationCodeErrors];
2241
- export type ContactsRequestConfirmationCodeResponses = {
2242
- /**
2243
- * Success
2244
- */
2245
- 204: void;
2246
- };
2247
- export type ContactsRequestConfirmationCodeResponse = ContactsRequestConfirmationCodeResponses[keyof ContactsRequestConfirmationCodeResponses];
2248
- export type ContactsBlockDeleteData = {
2249
- body?: never;
2250
- path: {
2251
- /**
2252
- * ID of the contact to unblock
2253
- */
2254
- id: number;
2255
- };
2256
- query?: never;
2257
- url: '/contacts/block/{id}';
2258
- };
2259
- export type ContactsBlockDeleteErrors = {
2260
- /**
2261
- * You cannot change contact status to this value
2262
- */
2263
- 400: {
2264
- message?: string;
2265
- };
2266
- /**
2267
- * Access to the contact was denied.
2268
- */
2269
- 403: {
2270
- message?: string;
2271
- };
2272
- /**
2273
- * Contact not found or or insufficient privileges
2274
- */
2275
- 404: {
2276
- message?: string;
2277
- };
2278
- };
2279
- export type ContactsBlockDeleteError = ContactsBlockDeleteErrors[keyof ContactsBlockDeleteErrors];
2280
- export type ContactsBlockDeleteResponses = {
2281
- /**
2282
- * Success
2283
- */
2284
- 204: void;
2285
- };
2286
- export type ContactsBlockDeleteResponse = ContactsBlockDeleteResponses[keyof ContactsBlockDeleteResponses];
2287
- export type ContactsBlockPutData = {
2288
- body?: never;
2289
- path: {
2290
- /**
2291
- * ID of the contact to block
2292
- */
2293
- id: number;
2294
- };
2295
- query?: never;
2296
- url: '/contacts/block/{id}';
2297
- };
2298
- export type ContactsBlockPutErrors = {
2299
- /**
2300
- * You cannot change contact status to this value
2301
- */
2302
- 400: {
2303
- message?: string;
2304
- };
2305
- /**
2306
- * Access to the contact was denied.
2307
- */
2308
- 403: {
2309
- message?: string;
2310
- };
2311
- /**
2312
- * Contact not found or or insufficient privileges
2313
- */
2314
- 404: {
2315
- message?: string;
2316
- };
2317
- };
2318
- export type ContactsBlockPutError = ContactsBlockPutErrors[keyof ContactsBlockPutErrors];
2319
- export type ContactsBlockPutResponses = {
2320
- /**
2321
- * Success
2322
- */
2323
- 204: void;
2324
- };
2325
- export type ContactsBlockPutResponse = ContactsBlockPutResponses[keyof ContactsBlockPutResponses];
2326
- export type ContactsReplaceNotificationsWithData = {
2327
- body?: never;
2328
- path: {
2329
- /**
2330
- * ID of the (old) contact being replaced
2331
- */
2332
- id: number;
2333
- /**
2334
- * ID of the (new) contact being used instead of the old one
2335
- */
2336
- to: number;
2337
- };
2338
- query?: never;
2339
- url: '/contacts/{id}/replaceInNotificationsWith/{to}';
2340
- };
2341
- export type ContactsReplaceNotificationsWithErrors = {
2342
- /**
2343
- * The old and new contact IDs are the same
2344
- */
2345
- 400: {
2346
- message?: string;
2347
- };
2348
- /**
2349
- * Access to the contact was denied.
2350
- */
2351
- 403: {
2352
- message?: string;
2353
- };
2354
- /**
2355
- * Contact not found or or insufficient privileges
2356
- */
2357
- 404: {
2358
- message?: string;
2359
- };
2360
- };
2361
- export type ContactsReplaceNotificationsWithError = ContactsReplaceNotificationsWithErrors[keyof ContactsReplaceNotificationsWithErrors];
2362
- export type ContactsReplaceNotificationsWithResponses = {
2363
- /**
2364
- * Success
2365
- */
2366
- 204: void;
2367
- };
2368
- export type ContactsReplaceNotificationsWithResponse = ContactsReplaceNotificationsWithResponses[keyof ContactsReplaceNotificationsWithResponses];
2369
- export type FoldersListData = {
2370
- body?: never;
2371
- path?: never;
2372
- query?: never;
2373
- url: '/folders';
2374
- };
2375
- export type FoldersListErrors = {
2376
- /**
2377
- * Not permitted to access
2378
- */
2379
- 403: Forbidden;
2380
- };
2381
- export type FoldersListError = FoldersListErrors[keyof FoldersListErrors];
2382
- export type FoldersListResponses = {
2383
- /**
2384
- * Success
2385
- */
2386
- 200: Array<FolderItem>;
2387
- };
2388
- export type FoldersListResponse = FoldersListResponses[keyof FoldersListResponses];
2389
- export type FolderPostData = {
2390
- /**
2391
- * Folder attributes
2392
- */
2393
- body: FolderRequestItem;
2394
- path?: never;
2395
- query?: never;
2396
- url: '/folders';
2397
- };
2398
- export type FolderPostErrors = {
2399
- /**
2400
- * Invalid data
2401
- */
2402
- 400: {
2403
- message?: string;
2404
- };
2405
- /**
2406
- * Not permitted to create
2407
- */
2408
- 403: Forbidden;
2409
- };
2410
- export type FolderPostError = FolderPostErrors[keyof FolderPostErrors];
2411
- export type FolderPostResponses = {
2412
- /**
2413
- * Success
2414
- */
2415
- 201: FolderItem;
2416
- };
2417
- export type FolderPostResponse = FolderPostResponses[keyof FolderPostResponses];
2418
- export type FolderDeleteData = {
2419
- body?: never;
2420
- path: {
2421
- /**
2422
- * Folder id
2423
- */
2424
- id: number;
2425
- };
2426
- query?: never;
2427
- url: '/folders/{id}';
2428
- };
2429
- export type FolderDeleteErrors = {
2430
- /**
2431
- * Not permitted to delete
2432
- */
2433
- 403: Forbidden;
2434
- /**
2435
- * Folder not found
2436
- */
2437
- 404: {
2438
- message?: string;
2439
- };
2440
- };
2441
- export type FolderDeleteError = FolderDeleteErrors[keyof FolderDeleteErrors];
2442
- export type FolderDeleteResponses = {
2443
- /**
2444
- * Success
2445
- */
2446
- 204: void;
2447
- };
2448
- export type FolderDeleteResponse = FolderDeleteResponses[keyof FolderDeleteResponses];
2449
- export type FolderGetData = {
2450
- body?: never;
2451
- path: {
2452
- /**
2453
- * Folder id
2454
- */
2455
- id: number;
2456
- };
2457
- query?: never;
2458
- url: '/folders/{id}';
2459
- };
2460
- export type FolderGetErrors = {
2461
- /**
2462
- * Not permitted to access
2463
- */
2464
- 403: Forbidden;
2465
- /**
2466
- * Folder not found
2467
- */
2468
- 404: {
2469
- message?: string;
2470
- };
2471
- };
2472
- export type FolderGetError = FolderGetErrors[keyof FolderGetErrors];
2473
- export type FolderGetResponses = {
2474
- /**
2475
- * Success
2476
- */
2477
- 200: FolderItem;
2478
- };
2479
- export type FolderGetResponse = FolderGetResponses[keyof FolderGetResponses];
2480
- export type FolderUpdateData = {
2481
- /**
2482
- * Folder attributes
2483
- */
2484
- body: FolderRequestItem;
2485
- path: {
2486
- /**
2487
- * Folder id
2488
- */
2489
- id: number;
2490
- };
2491
- query?: never;
2492
- url: '/folders/{id}';
2493
- };
2494
- export type FolderUpdateErrors = {
2495
- /**
2496
- * Invalid data
2497
- */
2498
- 400: {
2499
- message?: string;
2500
- };
2501
- /**
2502
- * Not permitted to update
2503
- */
2504
- 403: Forbidden;
2505
- /**
2506
- * Folder not found
2507
- */
2508
- 404: {
2509
- message?: string;
2510
- };
2511
- };
2512
- export type FolderUpdateError = FolderUpdateErrors[keyof FolderUpdateErrors];
2513
- export type FolderUpdateResponses = {
2514
- /**
2515
- * Success
2516
- */
2517
- 200: FolderItem;
2518
- };
2519
- export type FolderUpdateResponse = FolderUpdateResponses[keyof FolderUpdateResponses];
2520
- export type FolderAccessGetData = {
2521
- body?: never;
2522
- path: {
2523
- /**
2524
- * User id permissions are fetched for
2525
- */
2526
- user: number;
2527
- };
2528
- query?: never;
2529
- url: '/folders/access/{user}';
2530
- };
2531
- export type FolderAccessGetErrors = {
2532
- /**
2533
- * Not permitted to access
2534
- */
2535
- 403: Forbidden;
2536
- /**
2537
- * Not found
2538
- */
2539
- 404: {
2540
- message?: string;
2541
- };
2542
- };
2543
- export type FolderAccessGetError = FolderAccessGetErrors[keyof FolderAccessGetErrors];
2544
- export type FolderAccessGetResponses = {
2545
- /**
2546
- * Success
2547
- */
2548
- 200: Array<FolderItem>;
2549
- };
2550
- export type FolderAccessGetResponse = FolderAccessGetResponses[keyof FolderAccessGetResponses];
2551
- export type LocationsDeleteData = {
2552
- body?: never;
2553
- path: {
2554
- /**
2555
- * Location ID
2556
- */
2557
- id: number;
2558
- };
2559
- query?: never;
2560
- url: '/locations/{id}';
2561
- };
2562
- export type LocationsDeleteErrors = {
2563
- /**
2564
- * Invalid location - cannot be deleted (is not empty or is used)
2565
- */
2566
- 400: {
2567
- message?: string;
2568
- };
2569
- /**
2570
- * Not permitted to access
2571
- */
2572
- 403: Forbidden;
2573
- /**
2574
- * Not found
2575
- */
2576
- 404: {
2577
- message?: string;
2578
- };
2579
- };
2580
- export type LocationsDeleteError = LocationsDeleteErrors[keyof LocationsDeleteErrors];
2581
- export type LocationsDeleteResponses = {
2582
- /**
2583
- * Success
2584
- */
2585
- 204: void;
2586
- };
2587
- export type LocationsDeleteResponse = LocationsDeleteResponses[keyof LocationsDeleteResponses];
2588
- export type LocationsGetData = {
2589
- body?: never;
2590
- path: {
2591
- /**
2592
- * Location ID
2593
- */
2594
- id: number;
2595
- };
2596
- query?: never;
2597
- url: '/locations/{id}';
2598
- };
2599
- export type LocationsGetErrors = {
2600
- /**
2601
- * Not permitted to access
2602
- */
2603
- 403: Forbidden;
2604
- /**
2605
- * Not found
2606
- */
2607
- 404: {
2608
- message?: string;
2609
- };
2610
- };
2611
- export type LocationsGetError = LocationsGetErrors[keyof LocationsGetErrors];
2612
- export type LocationsGetResponses = {
2613
- /**
2614
- * Success
2615
- */
2616
- 200: Location;
2617
- };
2618
- export type LocationsGetResponse = LocationsGetResponses[keyof LocationsGetResponses];
2619
- export type LocationsPostData = {
2620
- /**
2621
- * Location object.
2622
- */
2623
- body: LocationDraft;
2624
- path: {
2625
- /**
2626
- * Location ID
2627
- */
2628
- id: number;
2629
- };
2630
- query?: never;
2631
- url: '/locations/{id}';
2632
- };
2633
- export type LocationsPostErrors = {
2634
- /**
2635
- * Invalid request - missing or invalid data
2636
- */
2637
- 400: {
2638
- message?: string;
2639
- };
2640
- /**
2641
- * Not permitted to access
2642
- */
2643
- 403: Forbidden;
2644
- /**
2645
- * Parent location not found
2646
- */
2647
- 404: {
2648
- message?: string;
2649
- };
2650
- };
2651
- export type LocationsPostError = LocationsPostErrors[keyof LocationsPostErrors];
2652
- export type LocationsPostResponses = {
2653
- /**
2654
- * Success
2655
- */
2656
- 200: Location;
2657
- };
2658
- export type LocationsPostResponse = LocationsPostResponses[keyof LocationsPostResponses];
2659
- export type LocationsGetByTypeData = {
2660
- body?: never;
2661
- path: {
2662
- /**
2663
- * Location type filter
2664
- */
2665
- type: 'private' | 'public' | 'all';
2666
- };
2667
- query?: never;
2668
- url: '/locations/{type}';
2669
- };
2670
- export type LocationsGetByTypeErrors = {
2671
- /**
2672
- * Not permitted to access
2673
- */
2674
- 403: Forbidden;
2675
- };
2676
- export type LocationsGetByTypeError = LocationsGetByTypeErrors[keyof LocationsGetByTypeErrors];
2677
- export type LocationsGetByTypeResponses = {
2678
- /**
2679
- * Success
2680
- */
2681
- 200: Array<Location>;
2682
- };
2683
- export type LocationsGetByTypeResponse = LocationsGetByTypeResponses[keyof LocationsGetByTypeResponses];
2684
- export type LocationsGetAllData = {
2685
- body?: never;
2686
- path?: never;
2687
- query?: never;
2688
- url: '/locations';
2689
- };
2690
- export type LocationsGetAllErrors = {
2691
- /**
2692
- * Not permitted to access
2693
- */
2694
- 403: Forbidden;
2695
- };
2696
- export type LocationsGetAllError = LocationsGetAllErrors[keyof LocationsGetAllErrors];
2697
- export type LocationsGetAllResponses = {
2698
- /**
2699
- * Success
2700
- */
2701
- 200: Array<Location>;
2702
- };
2703
- export type LocationsGetAllResponse = LocationsGetAllResponses[keyof LocationsGetAllResponses];
2704
- export type LocationsCreateData = {
2705
- /**
2706
- * Location object.
2707
- */
2708
- body: LocationDraft;
2709
- path?: never;
2710
- query?: never;
2711
- url: '/locations';
2712
- };
2713
- export type LocationsCreateErrors = {
2714
- /**
2715
- * Invalid request - missing or invalid data
2716
- */
2717
- 400: {
2718
- message?: string;
2719
- };
2720
- /**
2721
- * Not permitted to access
2722
- */
2723
- 403: Forbidden;
2724
- /**
2725
- * Parent location not found
2726
- */
2727
- 404: {
2728
- message?: string;
2729
- };
2730
- };
2731
- export type LocationsCreateError = LocationsCreateErrors[keyof LocationsCreateErrors];
2732
- export type LocationsCreateResponses = {
2733
- /**
2734
- * Success
2735
- */
2736
- 200: Location;
2737
- };
2738
- export type LocationsCreateResponse = LocationsCreateResponses[keyof LocationsCreateResponses];
2739
- export type LocationsLeafGetFilterData = {
2740
- body?: never;
2741
- path: {
2742
- /**
2743
- * Location filter
2744
- */
2745
- filter: 'private' | 'public' | 'all';
2746
- };
2747
- query?: never;
2748
- url: '/locations/leaf/{filter}';
2749
- };
2750
- export type LocationsLeafGetFilterErrors = {
2751
- /**
2752
- * Invalid request - invalid filter
2753
- */
2754
- 400: {
2755
- message?: string;
2756
- };
2757
- /**
2758
- * Not permitted to access
2759
- */
2760
- 403: Forbidden;
2761
- };
2762
- export type LocationsLeafGetFilterError = LocationsLeafGetFilterErrors[keyof LocationsLeafGetFilterErrors];
2763
- export type LocationsLeafGetFilterResponses = {
2764
- /**
2765
- * Success
2766
- */
2767
- 200: Array<Location>;
2768
- };
2769
- export type LocationsLeafGetFilterResponse = LocationsLeafGetFilterResponses[keyof LocationsLeafGetFilterResponses];
2770
- export type LogGetData = {
2771
- body?: never;
2772
- path?: never;
2773
- query?: {
2774
- /**
2775
- * List of monitors to query. If both 'monitors' and 'folders' are omitted, query all monitors. Format: Monitor name (string) or monitor ID (integer).
2776
- */
2777
- monitor?: Array<string>;
2778
- /**
2779
- * List of folders to query. If both 'monitors' and 'folders' are omitted, query all monitors. Format: Folder name (string) or folder ID (integer).
2780
- */
2781
- folder?: Array<string>;
2782
- /**
2783
- * List of locations to filter by. Format: Location name (string) or location ID (integer).
2784
- */
2785
- location?: Array<string>;
2786
- /**
2787
- * Start of interval. Format: ISO 8601 date and time or event ID.
2788
- */
2789
- from?: string;
2790
- /**
2791
- * End of interval. Format: ISO 8601 date and time or event ID.
2792
- */
2793
- to?: string;
2794
- /**
2795
- * Filter results by status.
2796
- */
2797
- status?: 'error' | 'confirmed_error';
2798
- /**
2799
- * Show extended results.
2800
- */
2801
- extended?: boolean;
2802
- /**
2803
- * Limit number of results.
2804
- */
2805
- limit?: number;
2806
- };
2807
- url: '/log';
2808
- };
2809
- export type LogGetErrors = {
2810
- /**
2811
- * Bad request
2812
- */
2813
- 400: {
2814
- message?: string;
2815
- };
2816
- /**
2817
- * Not permitted to access
2818
- */
2819
- 403: Forbidden;
2820
- };
2821
- export type LogGetError = LogGetErrors[keyof LogGetErrors];
2822
- export type LogGetResponses = {
2823
- /**
2824
- * Success
2825
- */
2826
- 200: Array<LogEvent>;
2827
- };
2828
- export type LogGetResponse = LogGetResponses[keyof LogGetResponses];
2829
- export type LogGetEventData = {
2830
- body?: never;
2831
- path: {
2832
- /**
2833
- * Event ID
2834
- */
2835
- id: string;
2836
- };
2837
- query?: never;
2838
- url: '/log/{id}';
2839
- };
2840
- export type LogGetEventErrors = {
2841
- /**
2842
- * Bad request
2843
- */
2844
- 400: {
2845
- message?: string;
2846
- };
2847
- /**
2848
- * Not permitted to access
2849
- */
2850
- 403: Forbidden;
2851
- };
2852
- export type LogGetEventError = LogGetEventErrors[keyof LogGetEventErrors];
2853
- export type LogGetEventResponses = {
2854
- /**
2855
- * Success
2856
- */
2857
- 200: LogEvent;
2858
- };
2859
- export type LogGetEventResponse = LogGetEventResponses[keyof LogGetEventResponses];
2860
- export type MaintenanceGetData = {
2861
- body?: never;
2862
- path?: never;
2863
- query?: {
2864
- /**
2865
- * Include also expired maintenance windows.
2866
- */
2867
- includeExpired?: boolean;
2868
- };
2869
- url: '/maintenances';
2870
- };
2871
- export type MaintenanceGetErrors = {
2872
- /**
2873
- * Insufficient permissions
2874
- */
2875
- 403: {
2876
- message?: string;
2877
- };
2878
- };
2879
- export type MaintenanceGetError = MaintenanceGetErrors[keyof MaintenanceGetErrors];
2880
- export type MaintenanceGetResponses = {
2881
- /**
2882
- * Success
2883
- */
2884
- 200: MaintenanceCatalogue;
2885
- };
2886
- export type MaintenanceGetResponse = MaintenanceGetResponses[keyof MaintenanceGetResponses];
2887
- export type MaintenancesCreateData = {
2888
- /**
2889
- * `name` and `windows` is required.
2890
- */
2891
- body: MaintenanceItemCreate;
2892
- path?: never;
2893
- query?: never;
2894
- url: '/maintenances';
2895
- };
2896
- export type MaintenancesCreateErrors = {
2897
- /**
2898
- * Wrong values were passed
2899
- */
2900
- 400: {
2901
- message?: string;
2902
- };
2903
- /**
2904
- * Insufficient permissions
2905
- */
2906
- 403: {
2907
- message?: string;
2908
- };
2909
- };
2910
- export type MaintenancesCreateError = MaintenancesCreateErrors[keyof MaintenancesCreateErrors];
2911
- export type MaintenancesCreateResponses = {
2912
- /**
2913
- * Success
2914
- */
2915
- 201: MaintenanceItem;
2916
- };
2917
- export type MaintenancesCreateResponse = MaintenancesCreateResponses[keyof MaintenancesCreateResponses];
2918
- export type MaintenanceDeleteData = {
2919
- body?: never;
2920
- path: {
2921
- /**
2922
- * Maintenance ID
2923
- */
2924
- id: number;
2925
- };
2926
- query?: never;
2927
- url: '/maintenances/{id}';
2928
- };
2929
- export type MaintenanceDeleteErrors = {
2930
- /**
2931
- * Not permitted to access
2932
- */
2933
- 403: Forbidden;
2934
- /**
2935
- * Maintenance not found
2936
- */
2937
- 404: {
2938
- message?: string;
2939
- };
2940
- };
2941
- export type MaintenanceDeleteError = MaintenanceDeleteErrors[keyof MaintenanceDeleteErrors];
2942
- export type MaintenanceDeleteResponses = {
2943
- /**
2944
- * Success
2945
- */
2946
- 204: void;
2947
- };
2948
- export type MaintenanceDeleteResponse = MaintenanceDeleteResponses[keyof MaintenanceDeleteResponses];
2949
- export type MaintenanceGetDetailData = {
2950
- body?: never;
2951
- path: {
2952
- /**
2953
- * The maintenance window ID
2954
- */
2955
- id: number;
2956
- };
2957
- query?: never;
2958
- url: '/maintenances/{id}';
2959
- };
2960
- export type MaintenanceGetDetailErrors = {
2961
- /**
2962
- * Not permitted to access
2963
- */
2964
- 403: Forbidden;
2965
- /**
2966
- * Not Found
2967
- */
2968
- 404: {
2969
- message?: string;
2970
- };
2971
- };
2972
- export type MaintenanceGetDetailError = MaintenanceGetDetailErrors[keyof MaintenanceGetDetailErrors];
2973
- export type MaintenanceGetDetailResponses = {
2974
- /**
2975
- * Success
2976
- */
2977
- 200: MaintenanceItem;
2978
- };
2979
- export type MaintenanceGetDetailResponse = MaintenanceGetDetailResponses[keyof MaintenanceGetDetailResponses];
2980
- export type MaintenancesUpdateData = {
2981
- /**
2982
- * Values not specified are not modified
2983
- */
2984
- body: MaintenanceItem;
2985
- path: {
2986
- /**
2987
- * The maintenance window ID
2988
- */
2989
- id: number;
2990
- };
2991
- query?: never;
2992
- url: '/maintenances/{id}';
2993
- };
2994
- export type MaintenancesUpdateErrors = {
2995
- /**
2996
- * Wrong values were passed
2997
- */
2998
- 400: {
2999
- message?: string;
3000
- };
3001
- /**
3002
- * Insufficient permissions
3003
- */
3004
- 403: {
3005
- message?: string;
3006
- };
3007
- };
3008
- export type MaintenancesUpdateError = MaintenancesUpdateErrors[keyof MaintenancesUpdateErrors];
3009
- export type MaintenancesUpdateResponses = {
3010
- /**
3011
- * Success
3012
- */
3013
- 200: MaintenanceItem;
3014
- };
3015
- export type MaintenancesUpdateResponse = MaintenancesUpdateResponses[keyof MaintenancesUpdateResponses];
3016
- export type MaintenanceGetWindowsData = {
3017
- body?: never;
3018
- path: {
3019
- /**
3020
- * The maintenance window ID
3021
- */
3022
- id: number;
3023
- };
3024
- query?: never;
3025
- url: '/maintenances/{id}/windows';
3026
- };
3027
- export type MaintenanceGetWindowsErrors = {
3028
- /**
3029
- * Not Found
3030
- */
3031
- 404: {
3032
- message?: string;
3033
- };
3034
- };
3035
- export type MaintenanceGetWindowsError = MaintenanceGetWindowsErrors[keyof MaintenanceGetWindowsErrors];
3036
- export type MaintenanceGetWindowsResponses = {
3037
- /**
3038
- * Success
3039
- */
3040
- 200: Array<MaintenanceWindowItem>;
3041
- };
3042
- export type MaintenanceGetWindowsResponse = MaintenanceGetWindowsResponses[keyof MaintenanceGetWindowsResponses];
3043
- export type MaintenancesPostWindowsData = {
3044
- body?: WindowItemCreate;
3045
- path: {
3046
- /**
3047
- * The ID of the maintenance window
3048
- */
3049
- id: number;
3050
- };
3051
- query?: never;
3052
- url: '/maintenances/{id}/windows';
3053
- };
3054
- export type MaintenancesPostWindowsErrors = {
3055
- /**
3056
- * Wrong values were passed
3057
- */
3058
- 400: {
3059
- message?: string;
3060
- };
3061
- /**
3062
- * Insufficient permissions
3063
- */
3064
- 403: {
3065
- message?: string;
3066
- };
3067
- /**
3068
- * Not Found
3069
- */
3070
- 404: {
3071
- message?: string;
3072
- };
3073
- };
3074
- export type MaintenancesPostWindowsError = MaintenancesPostWindowsErrors[keyof MaintenancesPostWindowsErrors];
3075
- export type MaintenancesPostWindowsResponses = {
3076
- /**
3077
- * Success
3078
- */
3079
- 201: MaintenanceWindowItem;
3080
- };
3081
- export type MaintenancesPostWindowsResponse = MaintenancesPostWindowsResponses[keyof MaintenancesPostWindowsResponses];
3082
- export type MaintenanceDeleteWindowsData = {
3083
- body?: never;
3084
- path: {
3085
- /**
3086
- * The maintenance window ID that the time window belongs to
3087
- */
3088
- maintenanceWindowId: number;
3089
- /**
3090
- * The time window to delete
3091
- */
3092
- timeWindowId: number;
3093
- };
3094
- query?: never;
3095
- url: '/maintenances/{maintenanceWindowId}/windows/{timeWindowId}';
3096
- };
3097
- export type MaintenanceDeleteWindowsErrors = {
3098
- /**
3099
- * Insufficient permissions
3100
- */
3101
- 403: {
3102
- message?: string;
3103
- };
3104
- /**
3105
- * Not Found
3106
- */
3107
- 404: {
3108
- message?: string;
3109
- };
3110
- };
3111
- export type MaintenanceDeleteWindowsError = MaintenanceDeleteWindowsErrors[keyof MaintenanceDeleteWindowsErrors];
3112
- export type MaintenanceDeleteWindowsResponses = {
3113
- /**
3114
- * Success
3115
- */
3116
- 204: void;
3117
- };
3118
- export type MaintenanceDeleteWindowsResponse = MaintenanceDeleteWindowsResponses[keyof MaintenanceDeleteWindowsResponses];
3119
- export type MaintenanceGetWindowsDetailData = {
3120
- body?: never;
3121
- path: {
3122
- /**
3123
- * The maintenance window ID
3124
- */
3125
- maintenanceWindowId: number;
3126
- /**
3127
- * The time window ID
3128
- */
3129
- timeWindowId: number;
3130
- };
3131
- query?: never;
3132
- url: '/maintenances/{maintenanceWindowId}/windows/{timeWindowId}';
3133
- };
3134
- export type MaintenanceGetWindowsDetailErrors = {
3135
- /**
3136
- * Not Found
3137
- */
3138
- 404: {
3139
- message?: string;
3140
- };
3141
- };
3142
- export type MaintenanceGetWindowsDetailError = MaintenanceGetWindowsDetailErrors[keyof MaintenanceGetWindowsDetailErrors];
3143
- export type MaintenanceGetWindowsDetailResponses = {
3144
- /**
3145
- * Success
3146
- */
3147
- 200: MaintenanceWindowItem;
3148
- };
3149
- export type MaintenanceGetWindowsDetailResponse = MaintenanceGetWindowsDetailResponses[keyof MaintenanceGetWindowsDetailResponses];
3150
- export type MaintenanceUpdateWindowsDetailData = {
3151
- body?: WindowItemCreate;
3152
- path: {
3153
- /**
3154
- * The maintenance window ID
3155
- */
3156
- maintenanceWindowId: number;
3157
- /**
3158
- * The individual window ID
3159
- */
3160
- timeWindowId: number;
3161
- };
3162
- query?: never;
3163
- url: '/maintenances/{maintenanceWindowId}/windows/{timeWindowId}';
3164
- };
3165
- export type MaintenanceUpdateWindowsDetailErrors = {
3166
- /**
3167
- * Not Found
3168
- */
3169
- 404: {
3170
- message?: string;
3171
- };
3172
- };
3173
- export type MaintenanceUpdateWindowsDetailError = MaintenanceUpdateWindowsDetailErrors[keyof MaintenanceUpdateWindowsDetailErrors];
3174
- export type MaintenanceUpdateWindowsDetailResponses = {
3175
- /**
3176
- * Success
3177
- */
3178
- 200: MaintenanceWindowItem;
3179
- };
3180
- export type MaintenanceUpdateWindowsDetailResponse = MaintenanceUpdateWindowsDetailResponses[keyof MaintenanceUpdateWindowsDetailResponses];
3181
- export type MaintenancesImmediateDeleteData = {
3182
- /**
3183
- * Ids of monitors the immediate maintenance should be finished. You need update permission for these monitors
3184
- */
3185
- body: Array<number>;
3186
- path?: never;
3187
- query?: never;
3188
- url: '/maintenances/immediate';
3189
- };
3190
- export type MaintenancesImmediateDeleteErrors = {
3191
- /**
3192
- * Wrong values were passed
3193
- */
3194
- 400: {
3195
- message?: string;
3196
- };
3197
- /**
3198
- * Insufficient permissions
3199
- */
3200
- 403: Forbidden;
3201
- };
3202
- export type MaintenancesImmediateDeleteError = MaintenancesImmediateDeleteErrors[keyof MaintenancesImmediateDeleteErrors];
3203
- export type MaintenancesImmediateDeleteResponses = {
3204
- /**
3205
- * Success
3206
- */
3207
- 204: void;
3208
- };
3209
- export type MaintenancesImmediateDeleteResponse = MaintenancesImmediateDeleteResponses[keyof MaintenancesImmediateDeleteResponses];
3210
- export type MaintenancesImmediatePutData = {
3211
- /**
3212
- * Immediate maintenance window
3213
- */
3214
- body: MaintenanceItemImmediateCreate;
3215
- path?: never;
3216
- query?: never;
3217
- url: '/maintenances/immediate';
3218
- };
3219
- export type MaintenancesImmediatePutErrors = {
3220
- /**
3221
- * Wrong values were passed
3222
- */
3223
- 400: {
3224
- message?: string;
3225
- };
3226
- /**
3227
- * Insufficient permissions
3228
- */
3229
- 403: Forbidden;
3230
- };
3231
- export type MaintenancesImmediatePutError = MaintenancesImmediatePutErrors[keyof MaintenancesImmediatePutErrors];
3232
- export type MaintenancesImmediatePutResponses = {
3233
- /**
3234
- * Success
3235
- */
3236
- 204: void;
3237
- };
3238
- export type MaintenancesImmediatePutResponse = MaintenancesImmediatePutResponses[keyof MaintenancesImmediatePutResponses];
3239
- export type MessagesListData = {
3240
- body?: never;
3241
- path?: never;
3242
- query?: {
3243
- /**
3244
- * Filter alerts related to a monitor.
3245
- */
3246
- monitorId?: number;
3247
- /**
3248
- * Filter alerts related to monitors in a folder.
3249
- */
3250
- folderId?: number;
3251
- /**
3252
- * Select messages that represent some monitor alert or not. Note: expire certificate notifications are not alerts - they are not bound to a particular monitor or contact.
3253
- */
3254
- isAlert?: boolean;
3255
- /**
3256
- * Contact ID. You need contact update permission to filter by the contact.
3257
- */
3258
- contactId?: number;
3259
- /**
3260
- * Select messages by message type.
3261
- */
3262
- type?: 'email' | 'sms' | 'phone' | 'action' | 'rss';
3263
- /**
3264
- * Select messages by message status.
3265
- */
3266
- status?: 'deleted' | 'queued' | 'gateway' | 'provider' | 'device' | 'accepted' | 'queued-no-fallback' | 'undeliverable' | 'suppressed';
3267
- /**
3268
- * Select messages by date and time when it was sent. It can also be provided as positive integer - the oldest message ID.
3269
- */
3270
- from?: string;
3271
- /**
3272
- * Select messages by date and time when it was sent. It can also be provided as positive integer - the newest message ID.
3273
- */
3274
- to?: string;
3275
- /**
3276
- * Max number of results to return.
3277
- */
3278
- limit?: number;
3279
- };
3280
- url: '/messages';
3281
- };
3282
- export type MessagesListErrors = {
3283
- /**
3284
- * Bad request
3285
- */
3286
- 400: unknown;
3287
- /**
3288
- * Not permitted to access
3289
- */
3290
- 403: Forbidden;
3291
- /**
3292
- * Not found
3293
- */
3294
- 404: unknown;
3295
- };
3296
- export type MessagesListError = MessagesListErrors[keyof MessagesListErrors];
3297
- export type MessagesListResponses = {
3298
- /**
3299
- * Success
3300
- */
3301
- 200: Array<MessageItem>;
3302
- };
3303
- export type MessagesListResponse = MessagesListResponses[keyof MessagesListResponses];
3304
- export type MessageGetData = {
3305
- body?: never;
3306
- path: {
3307
- /**
3308
- * Message id
3309
- */
3310
- id: number;
3311
- };
3312
- query?: never;
3313
- url: '/messages/{id}';
3314
- };
3315
- export type MessageGetErrors = {
3316
- /**
3317
- * Not permitted to access
3318
- */
3319
- 403: Forbidden;
3320
- };
3321
- export type MessageGetError = MessageGetErrors[keyof MessageGetErrors];
3322
- export type MessageGetResponses = {
3323
- /**
3324
- * Success
3325
- */
3326
- 200: MessageItem;
3327
- };
3328
- export type MessageGetResponse = MessageGetResponses[keyof MessageGetResponses];
3329
- export type MonitorGetAllData = {
3330
- body?: never;
3331
- path?: never;
3332
- query?: {
3333
- /**
3334
- * Flag for reading the simple and fast list of monitor frames. If true, the simple monitor schemas (MonitorFrame) are returned in the response (which should be slightly faster), the full schema (Monitor) otherwise
3335
- */
3336
- framesOnly?: boolean;
3337
- /**
3338
- * Flag for sending response together with the pagination information. If true, the MonitorsPage schema is returned with pagination information, the simple array of matching monitors otherwise.
3339
- */
3340
- pagination?: boolean;
3341
- /**
3342
- * Monitor ID or comma separated list of monitor IDs.
3343
- */
3344
- monitorId?: string;
3345
- /**
3346
- * Folder ID. Use 0 for monitors out of folder.
3347
- */
3348
- folderId?: number;
3349
- /**
3350
- * Select monitors user has this level of access.
3351
- */
3352
- accessLevel?: 'view' | 'update' | 'create-delete';
3353
- /**
3354
- * Select monitors by type.
3355
- */
3356
- type?: 'browser' | 'connect' | 'dnsa' | 'dnsns' | 'dns' | 'domain' | 'ftp' | 'ftps' | 'http' | 'https' | 'imap' | 'ldap' | 'ping' | 'plugin' | 'pop3' | 'scp' | 'script' | 'sftp' | 'sip' | 'smtp' | 'telnet' | 'webdriver';
3357
- /**
3358
- * Flag for filtering active monitors only.
3359
- */
3360
- isActive?: boolean;
3361
- /**
3362
- * Flag for filtering failing monitors only. With false both the active non-failing monitors and inactive monitors are returned.
3363
- */
3364
- inError?: boolean;
3365
- /**
3366
- * Flag for filtering monitors with unhealthy pool of stations.
3367
- */
3368
- isUnhealthy?: boolean;
3369
- /**
3370
- * Flag for filtering monitors configured to use a proxy or not.
3371
- */
3372
- proxy?: 'none' | 'system' | 'custom';
3373
- /**
3374
- * Flag for filtering monitors with authentication enabled.
3375
- */
3376
- hasAuthentication?: boolean;
3377
- /**
3378
- * Select monitors by username used in authentication.
3379
- */
3380
- username?: string;
3381
- /**
3382
- * Select monitors that are tagged by one of this tags (pipe separated list).
3383
- */
3384
- tag?: string;
3385
- /**
3386
- * Select monitors by name. See also the nameMatchType option below.
3387
- */
3388
- name?: string;
3389
- /**
3390
- * Match type for the monitor-by-name filtering. I nameMatchType is 'full' (or empty as this is default) the name must be equal to the filter value, if 'partial' the name must contain the filter value.
3391
- */
3392
- nameMatchType?: 'full' | 'partial';
3393
- /**
3394
- * Monitoring location ID.
3395
- */
3396
- locationId?: number;
3397
- /**
3398
- * Monitoring station ID.
3399
- */
3400
- stationId?: number;
3401
- /**
3402
- * Flag for filtering by station or monitor ID. If true, find only monitors explicitly configured for the location, i.e. do not select monitors with empty (default) pool. Default is false for public stations / locations, true for OPMS.
3403
- */
3404
- explicitPoolOnly?: boolean;
3405
- /**
3406
- * Low monitor ID limit for pagination (needs sorting by monitor ID)
3407
- */
3408
- from?: number;
3409
- /**
3410
- * High monitor ID limit for pagination (needs sorting by monitor ID)
3411
- */
3412
- to?: number;
3413
- /**
3414
- * Max number of results to return.
3415
- */
3416
- limit?: number;
3417
- /**
3418
- * Zero based offset for pagination. Limit is required if offset is set.
3419
- */
3420
- offset?: number;
3421
- /**
3422
- * Order by string.
3423
- */
3424
- order?: string;
3425
- };
3426
- url: '/monitors';
3427
- };
3428
- export type MonitorGetAllErrors = {
3429
- /**
3430
- * Not permitted to access
3431
- */
3432
- 403: Forbidden;
3433
- /**
3434
- * Not found
3435
- */
3436
- 404: {
3437
- message?: string;
3438
- };
3439
- };
3440
- export type MonitorGetAllError = MonitorGetAllErrors[keyof MonitorGetAllErrors];
3441
- export type MonitorGetAllResponses = {
3442
- /**
3443
- * Success. The result returned depends on the framesOnly and pagination parameters.
3444
- */
3445
- 200: MonitorsPage | Array<Browser | Connect | Dns | Dnsa | Dnsns | Domain | Ftp | Ftps | Http | Https | Imap | Ldap | Ping | Plugin | Pop3 | Scp | Script | Sftp | Sip | Smtp | Telnet | Webdriver | MonitorFrame>;
3446
- };
3447
- export type MonitorGetAllResponse = MonitorGetAllResponses[keyof MonitorGetAllResponses];
3448
- export type MonitorCreateData = {
3449
- /**
3450
- * Monitor settings
3451
- */
3452
- body: BrowserCreate | ConnectCreate | DnsCreate | DnsaCreate | DnsnsCreate | DomainCreate | FtpCreate | FtpsCreate | HttpCreate | HttpsCreate | ImapCreate | LdapCreate | PingCreate | PluginCreate | Pop3Create | ScpCreate | ScriptCreate | SftpCreate | SipCreate | SmtpCreate | TelnetCreate | WebdriverCreate;
3453
- path?: never;
3454
- query?: never;
3455
- url: '/monitors';
3456
- };
3457
- export type MonitorCreateErrors = {
3458
- /**
3459
- * Bad request
3460
- */
3461
- 400: {
3462
- status?: string;
3463
- message?: string;
3464
- data?: {
3465
- details?: unknown;
3466
- };
3467
- };
3468
- /**
3469
- * Not permitted to access
3470
- */
3471
- 403: Forbidden;
3472
- };
3473
- export type MonitorCreateError = MonitorCreateErrors[keyof MonitorCreateErrors];
3474
- export type MonitorCreateResponses = {
3475
- /**
3476
- * Success
3477
- */
3478
- 201: {
3479
- monitorId?: number;
3480
- };
3481
- };
3482
- export type MonitorCreateResponse = MonitorCreateResponses[keyof MonitorCreateResponses];
3483
- export type MonitorDeleteData = {
3484
- body?: never;
3485
- path: {
3486
- /**
3487
- * Monitor ID
3488
- */
3489
- id: number;
3490
- };
3491
- query?: never;
3492
- url: '/monitors/{id}';
3493
- };
3494
- export type MonitorDeleteErrors = {
3495
- /**
3496
- * Not permitted to access
3497
- */
3498
- 403: Forbidden;
3499
- /**
3500
- * Not found
3501
- */
3502
- 404: unknown;
3503
- };
3504
- export type MonitorDeleteError = MonitorDeleteErrors[keyof MonitorDeleteErrors];
3505
- export type MonitorDeleteResponses = {
3506
- /**
3507
- * Success
3508
- */
3509
- 200: unknown;
3510
- };
3511
- export type MonitorGetData = {
3512
- body?: never;
3513
- path: {
3514
- /**
3515
- * Monitor ID
3516
- */
3517
- id: number;
3518
- };
3519
- query?: {
3520
- /**
3521
- * Export the full monitor schema
3522
- */
3523
- export?: boolean;
3524
- };
3525
- url: '/monitors/{id}';
3526
- };
3527
- export type MonitorGetErrors = {
3528
- /**
3529
- * Not permitted to access
3530
- */
3531
- 403: Forbidden;
3532
- };
3533
- export type MonitorGetError = MonitorGetErrors[keyof MonitorGetErrors];
3534
- export type MonitorGetResponses = {
3535
- /**
3536
- * Success
3537
- */
3538
- 200: Browser | Connect | Dns | Dnsa | Dnsns | Domain | Ftp | Ftps | Http | Https | Imap | Ldap | Ping | Plugin | Pop3 | Scp | Script | Sftp | Sip | Smtp | Telnet | Webdriver;
3539
- };
3540
- export type MonitorGetResponse = MonitorGetResponses[keyof MonitorGetResponses];
3541
- export type MonitorUpdateData = {
3542
- /**
3543
- * Monitor settings
3544
- */
3545
- body: BrowserUpdate | ConnectUpdate | DnsUpdate | DnsaUpdate | DnsnsUpdate | DomainUpdate | FtpUpdate | FtpsUpdate | HttpUpdate | HttpsUpdate | ImapUpdate | LdapUpdate | PingUpdate | PluginUpdate | Pop3Update | ScpUpdate | ScriptUpdate | SftpUpdate | SipUpdate | SmtpUpdate | TelnetUpdate | WebdriverUpdate;
3546
- path: {
3547
- /**
3548
- * Monitor ID
3549
- */
3550
- id: number;
3551
- };
3552
- query?: never;
3553
- url: '/monitors/{id}';
3554
- };
3555
- export type MonitorUpdateErrors = {
3556
- /**
3557
- * Bad request
3558
- */
3559
- 400: {
3560
- status?: string;
3561
- message?: string;
3562
- data?: {
3563
- details?: unknown;
3564
- };
3565
- };
3566
- /**
3567
- * Not permitted to access
3568
- */
3569
- 403: Forbidden;
3570
- };
3571
- export type MonitorUpdateError = MonitorUpdateErrors[keyof MonitorUpdateErrors];
3572
- export type MonitorUpdateResponses = {
3573
- /**
3574
- * Success
3575
- */
3576
- 200: {
3577
- message?: string;
3578
- };
3579
- };
3580
- export type MonitorUpdateResponse = MonitorUpdateResponses[keyof MonitorUpdateResponses];
3581
- export type MonitorActivateData = {
3582
- body?: never;
3583
- path?: never;
3584
- query: {
3585
- /**
3586
- * List of monitors to activate. Format: Comma-separated monitor IDs or monitor names
3587
- */
3588
- monitor: Array<string>;
3589
- };
3590
- url: '/monitors/activate';
3591
- };
3592
- export type MonitorActivateErrors = {
3593
- /**
3594
- * Bad request
3595
- */
3596
- 400: unknown;
3597
- /**
3598
- * Subscription not enough for activation
3599
- */
3600
- 402: unknown;
3601
- /**
3602
- * Not permitted
3603
- */
3604
- 403: unknown;
3605
- /**
3606
- * Not found
3607
- */
3608
- 404: unknown;
3609
- };
3610
- export type MonitorActivateResponses = {
3611
- /**
3612
- * Successful activation
3613
- */
3614
- 200: {
3615
- responses?: Array<{
3616
- id?: unknown;
3617
- status?: number;
3618
- resource?: unknown;
3619
- message?: string;
3620
- }>;
3621
- metadata?: BulkResponseMetadata;
3622
- };
3623
- /**
3624
- * Multiple results. If the results in the bulk response have a mix of different HTTP codes, the final HTTP code will be 207 Multi-status. In that case check the results carefully one by one.
3625
- */
3626
- 207: {
3627
- status?: string;
3628
- message?: string;
3629
- data?: BulkResponse;
3630
- };
3631
- };
3632
- export type MonitorActivateResponse = MonitorActivateResponses[keyof MonitorActivateResponses];
3633
- export type MonitorDeactivateData = {
3634
- body?: never;
3635
- path?: never;
3636
- query: {
3637
- /**
3638
- * List of monitors to deactivate. Format: Comma-separated monitor IDs or monitor names
3639
- */
3640
- monitor: Array<string>;
3641
- };
3642
- url: '/monitors/deactivate';
3643
- };
3644
- export type MonitorDeactivateErrors = {
3645
- /**
3646
- * Bad request
3647
- */
3648
- 400: unknown;
3649
- /**
3650
- * Not permitted
3651
- */
3652
- 403: unknown;
3653
- /**
3654
- * Not found
3655
- */
3656
- 404: unknown;
3657
- };
3658
- export type MonitorDeactivateResponses = {
3659
- /**
3660
- * A successful deactivation
3661
- */
3662
- 200: {
3663
- responses?: Array<{
3664
- id?: unknown;
3665
- status?: number;
3666
- resource?: unknown;
3667
- message?: string;
3668
- }>;
3669
- metadata?: BulkResponseMetadata;
3670
- };
3671
- /**
3672
- * Multiple results. If the results in the bulk response have a mix of different HTTP codes, the final HTTP code will be 207 Multi-status. In that case check the results carefully one by one.
3673
- */
3674
- 207: {
3675
- status?: string;
3676
- message?: string;
3677
- data?: BulkResponse;
3678
- };
3679
- };
3680
- export type MonitorDeactivateResponse = MonitorDeactivateResponses[keyof MonitorDeactivateResponses];
3681
- export type OauthClientTokensListData = {
3682
- body?: never;
3683
- path?: never;
3684
- query?: never;
3685
- url: '/oauth2';
3686
- };
3687
- export type OauthClientTokensListErrors = {
3688
- /**
3689
- * Not permitted to access
3690
- */
3691
- 403: Forbidden;
3692
- };
3693
- export type OauthClientTokensListError = OauthClientTokensListErrors[keyof OauthClientTokensListErrors];
3694
- export type OauthClientTokensListResponses = {
3695
- /**
3696
- * Success
3697
- */
3698
- 200: Array<OauthClientCredentialsItem>;
3699
- };
3700
- export type OauthClientTokensListResponse = OauthClientTokensListResponses[keyof OauthClientTokensListResponses];
3701
- export type OauthClientTokensCreateData = {
3702
- /**
3703
- * The request body. Name is required, everything else is optional.
3704
- */
3705
- body: {
3706
- name?: string;
3707
- valid_until?: string;
3708
- access_token_validity?: number;
3709
- refresh_token_validity?: number;
3710
- };
3711
- path?: never;
3712
- query?: never;
3713
- url: '/oauth2';
3714
- };
3715
- export type OauthClientTokensCreateErrors = {
3716
- /**
3717
- * Not permitted to access
3718
- */
3719
- 403: Forbidden;
3720
- };
3721
- export type OauthClientTokensCreateError = OauthClientTokensCreateErrors[keyof OauthClientTokensCreateErrors];
3722
- export type OauthClientTokensCreateResponses = {
3723
- /**
3724
- * Success
3725
- */
3726
- 201: {
3727
- status?: string;
3728
- data?: {
3729
- id?: number;
3730
- name?: string;
3731
- client_id?: string;
3732
- valid_until?: string;
3733
- access_token_validity?: number;
3734
- refresh_token_validity?: number;
3735
- client_secret?: string;
3736
- };
3737
- };
3738
- };
3739
- export type OauthClientTokensCreateResponse = OauthClientTokensCreateResponses[keyof OauthClientTokensCreateResponses];
3740
- export type OauthClientTokensDeleteData = {
3741
- body?: never;
3742
- path: {
3743
- /**
3744
- * The ID of the credentials to delete
3745
- */
3746
- id: number;
3747
- };
3748
- query?: never;
3749
- url: '/oauth2/{id}';
3750
- };
3751
- export type OauthClientTokensDeleteErrors = {
3752
- /**
3753
- * Not permitted to access
3754
- */
3755
- 403: Forbidden;
3756
- /**
3757
- * Not found
3758
- */
3759
- 404: OauthClientCredentialsNotFound;
3760
- };
3761
- export type OauthClientTokensDeleteError = OauthClientTokensDeleteErrors[keyof OauthClientTokensDeleteErrors];
3762
- export type OauthClientTokensDeleteResponses = {
3763
- /**
3764
- * Success
3765
- */
3766
- 200: {
3767
- message?: string;
3768
- };
3769
- };
3770
- export type OauthClientTokensDeleteResponse = OauthClientTokensDeleteResponses[keyof OauthClientTokensDeleteResponses];
3771
- export type OauthClientTokensGetData = {
3772
- body?: never;
3773
- path: {
3774
- /**
3775
- * The ID of the credentials
3776
- */
3777
- id: number;
3778
- };
3779
- query?: never;
3780
- url: '/oauth2/{id}';
3781
- };
3782
- export type OauthClientTokensGetErrors = {
3783
- /**
3784
- * Not permitted to access
3785
- */
3786
- 403: Forbidden;
3787
- /**
3788
- * Not found
3789
- */
3790
- 404: OauthClientCredentialsNotFound;
3791
- };
3792
- export type OauthClientTokensGetError = OauthClientTokensGetErrors[keyof OauthClientTokensGetErrors];
3793
- export type OauthClientTokensGetResponses = {
3794
- /**
3795
- * Success
3796
- */
3797
- 200: OauthClientCredentialsItem;
3798
- };
3799
- export type OauthClientTokensGetResponse = OauthClientTokensGetResponses[keyof OauthClientTokensGetResponses];
3800
- export type OauthClientTokensUpdateData = {
3801
- /**
3802
- * The request body. Name is required, everything else is optional.
3803
- */
3804
- body: {
3805
- name?: string;
3806
- valid_until?: string;
3807
- access_token_validity?: number;
3808
- refresh_token_validity?: number;
3809
- };
3810
- path: {
3811
- /**
3812
- * The ID of the credentials to update
3813
- */
3814
- id: number;
3815
- };
3816
- query?: never;
3817
- url: '/oauth2/{id}';
3818
- };
3819
- export type OauthClientTokensUpdateErrors = {
3820
- /**
3821
- * Not permitted to access
3822
- */
3823
- 403: Forbidden;
3824
- /**
3825
- * Not found
3826
- */
3827
- 404: OauthClientCredentialsNotFound;
3828
- };
3829
- export type OauthClientTokensUpdateError = OauthClientTokensUpdateErrors[keyof OauthClientTokensUpdateErrors];
3830
- export type OauthClientTokensUpdateResponses = {
3831
- /**
3832
- * Success
3833
- */
3834
- 200: {
3835
- message?: string;
3836
- data?: OauthClientCredentialsItem;
3837
- };
3838
- };
3839
- export type OauthClientTokensUpdateResponse = OauthClientTokensUpdateResponses[keyof OauthClientTokensUpdateResponses];
3840
- export type OauthTokenDeleteCurrentData = {
3841
- body?: never;
3842
- path?: never;
3843
- query?: never;
3844
- url: '/oauth2/token';
3845
- };
3846
- export type OauthTokenDeleteCurrentErrors = {
3847
- /**
3848
- * Bad request
3849
- */
3850
- 400: {
3851
- error?: string;
3852
- };
3853
- };
3854
- export type OauthTokenDeleteCurrentError = OauthTokenDeleteCurrentErrors[keyof OauthTokenDeleteCurrentErrors];
3855
- export type OauthTokenDeleteCurrentResponses = {
3856
- /**
3857
- * Success
3858
- */
3859
- 200: unknown;
3860
- };
3861
- export type OauthGetTokenListData = {
3862
- body?: never;
3863
- path?: never;
3864
- query?: {
3865
- /**
3866
- * Flag for including expired tokens. By default expired tokens are not returned.
3867
- */
3868
- expired?: boolean;
3869
- };
3870
- url: '/oauth2/token';
3871
- };
3872
- export type OauthGetTokenListErrors = {
3873
- /**
3874
- * Not permitted to access
3875
- */
3876
- 403: unknown;
3877
- };
3878
- export type OauthGetTokenListResponses = {
3879
- /**
3880
- * Success
3881
- */
3882
- 200: Array<OauthToken>;
3883
- };
3884
- export type OauthGetTokenListResponse = OauthGetTokenListResponses[keyof OauthGetTokenListResponses];
3885
- export type OauthCreateTokenData = {
3886
- body?: {
3887
- /**
3888
- * The grant type according to OAuth2 specification
3889
- */
3890
- grant_type: 'authorization_code' | 'client_credentials' | 'refresh_token';
3891
- /**
3892
- * The client ID, required for client_credentials and authorization_code grants.
3893
- */
3894
- client_id?: string;
3895
- /**
3896
- * The client secret, required for client_credentials, optional for authorization_code.
3897
- */
3898
- client_secret?: string;
3899
- /**
3900
- * Refresh token user for refresh_token grant.
3901
- */
3902
- refresh_token?: string;
3903
- /**
3904
- * Authorization code used in authorization_code grant.
3905
- */
3906
- code?: string;
3907
- /**
3908
- * Redirect URI used in authorization_code grant.
3909
- */
3910
- redirect_uri?: string;
3911
- };
3912
- path?: never;
3913
- query?: never;
3914
- url: '/oauth2/token';
3915
- };
3916
- export type OauthCreateTokenErrors = {
3917
- /**
3918
- * Invalid data sent
3919
- */
3920
- 400: {
3921
- /**
3922
- * The error code
3923
- */
3924
- error?: string;
3925
- /**
3926
- * The error message
3927
- */
3928
- error_description?: string;
3929
- };
3930
- /**
3931
- * Invalid credentials
3932
- */
3933
- 401: {
3934
- /**
3935
- * The error code
3936
- */
3937
- error?: string;
3938
- /**
3939
- * The error message
3940
- */
3941
- error_description?: string;
3942
- };
3943
- };
3944
- export type OauthCreateTokenError = OauthCreateTokenErrors[keyof OauthCreateTokenErrors];
3945
- export type OauthCreateTokenResponses = {
3946
- /**
3947
- * Success - refresh_token and client_credentials grants.
3948
- */
3949
- 200: {
3950
- /**
3951
- * The new access token
3952
- */
3953
- access_token?: string;
3954
- /**
3955
- * Always 'bearer'
3956
- */
3957
- token_type?: string;
3958
- /**
3959
- * The remaining time in seconds until access token expires
3960
- */
3961
- expires_in?: number;
3962
- /**
3963
- * A token that can be used to refresh the access token
3964
- */
3965
- refresh_token?: string;
3966
- /**
3967
- * The remaining time in seconds until refresh token expires
3968
- */
3969
- refresh_token_expires_in?: number;
3970
- };
3971
- };
3972
- export type OauthCreateTokenResponse = OauthCreateTokenResponses[keyof OauthCreateTokenResponses];
3973
- export type OauthGetRefreshTokenListData = {
3974
- body?: never;
3975
- path?: never;
3976
- query?: {
3977
- /**
3978
- * Flag for including expired tokens. By default expired tokens are not returned.
3979
- */
3980
- expired?: boolean;
3981
- };
3982
- url: '/oauth2/refreshtoken';
3983
- };
3984
- export type OauthGetRefreshTokenListErrors = {
3985
- /**
3986
- * Not permitted to access
3987
- */
3988
- 403: unknown;
3989
- };
3990
- export type OauthGetRefreshTokenListResponses = {
3991
- /**
3992
- * Success
3993
- */
3994
- 200: Array<OauthToken>;
3995
- };
3996
- export type OauthGetRefreshTokenListResponse = OauthGetRefreshTokenListResponses[keyof OauthGetRefreshTokenListResponses];
3997
- export type OauthTokenDeleteData = {
3998
- body?: never;
3999
- path: {
4000
- /**
4001
- * The access token or the ID of access token to invalidate
4002
- */
4003
- token: string | number;
4004
- };
4005
- query?: never;
4006
- url: '/oauth2/token/{token}';
4007
- };
4008
- export type OauthTokenDeleteErrors = {
4009
- /**
4010
- * Bad request
4011
- */
4012
- 400: {
4013
- error?: string;
4014
- };
4015
- };
4016
- export type OauthTokenDeleteError = OauthTokenDeleteErrors[keyof OauthTokenDeleteErrors];
4017
- export type OauthTokenDeleteResponses = {
4018
- /**
4019
- * Success
4020
- */
4021
- 200: unknown;
4022
- };
4023
- export type OauthRefreshTokenDeleteIdData = {
4024
- body?: never;
4025
- path: {
4026
- id: number;
4027
- };
4028
- query?: never;
4029
- url: '/oauth2/refreshtoken/{id}';
4030
- };
4031
- export type OauthRefreshTokenDeleteIdErrors = {
4032
- /**
4033
- * Bad request
4034
- */
4035
- 400: unknown;
4036
- /**
4037
- * Not found
4038
- */
4039
- 404: unknown;
4040
- };
4041
- export type OauthRefreshTokenDeleteIdResponses = {
4042
- /**
4043
- * Success
4044
- */
4045
- 200: unknown;
4046
- };
4047
- export type OauthTokenCognateDeleteCurrentData = {
4048
- body?: never;
4049
- path?: never;
4050
- query?: never;
4051
- url: '/oauth2/cognate-tokens';
4052
- };
4053
- export type OauthTokenCognateDeleteCurrentErrors = {
4054
- /**
4055
- * Bad request
4056
- */
4057
- 400: {
4058
- error?: string;
4059
- };
4060
- };
4061
- export type OauthTokenCognateDeleteCurrentError = OauthTokenCognateDeleteCurrentErrors[keyof OauthTokenCognateDeleteCurrentErrors];
4062
- export type OauthTokenCognateDeleteCurrentResponses = {
4063
- /**
4064
- * Success
4065
- */
4066
- 200: unknown;
4067
- };
4068
- export type OauthTokenCognateDeleteData = {
4069
- body?: never;
4070
- path: {
4071
- /**
4072
- * The access token, if empty access token from current request is used
4073
- */
4074
- token: string;
4075
- };
4076
- query?: never;
4077
- url: '/oauth2/cognate-tokens/{token}';
4078
- };
4079
- export type OauthTokenCognateDeleteErrors = {
4080
- /**
4081
- * Bad request
4082
- */
4083
- 400: {
4084
- error?: string;
4085
- };
4086
- };
4087
- export type OauthTokenCognateDeleteError = OauthTokenCognateDeleteErrors[keyof OauthTokenCognateDeleteErrors];
4088
- export type OauthTokenCognateDeleteResponses = {
4089
- /**
4090
- * Success
4091
- */
4092
- 200: unknown;
4093
- };
4094
- export type SettingsGetData = {
4095
- body?: never;
4096
- path?: never;
4097
- query?: never;
4098
- url: '/settings';
4099
- };
4100
- export type SettingsGetErrors = {
4101
- /**
4102
- * Not permitted to access
4103
- */
4104
- 403: Forbidden;
4105
- };
4106
- export type SettingsGetError = SettingsGetErrors[keyof SettingsGetErrors];
4107
- export type SettingsGetResponses = {
4108
- /**
4109
- * Success
4110
- */
4111
- 200: Array<SettingsItem>;
4112
- };
4113
- export type SettingsGetResponse = SettingsGetResponses[keyof SettingsGetResponses];
4114
- export type SettingsGetDetailData = {
4115
- body?: never;
4116
- path: {
4117
- /**
4118
- * The setting name
4119
- */
4120
- name: string;
4121
- };
4122
- query?: never;
4123
- url: '/settings/{name}';
4124
- };
4125
- export type SettingsGetDetailErrors = {
4126
- /**
4127
- * Invalid parameter name
4128
- */
4129
- 400: {
4130
- message?: string;
4131
- };
4132
- /**
4133
- * Not permitted to access
4134
- */
4135
- 403: Forbidden;
4136
- };
4137
- export type SettingsGetDetailError = SettingsGetDetailErrors[keyof SettingsGetDetailErrors];
4138
- export type SettingsGetDetailResponses = {
4139
- /**
4140
- * Success
4141
- */
4142
- 200: SettingsItem;
4143
- };
4144
- export type SettingsGetDetailResponse = SettingsGetDetailResponses[keyof SettingsGetDetailResponses];
4145
- export type SettingsUpdateData = {
4146
- /**
4147
- * The settings value
4148
- */
4149
- body?: unknown;
4150
- path: {
4151
- /**
4152
- * The settigns name
4153
- */
4154
- name: string;
4155
- };
4156
- query?: never;
4157
- url: '/settings/{name}';
4158
- };
4159
- export type SettingsUpdateErrors = {
4160
- /**
4161
- * Wrong parameter name or value was passed
4162
- */
4163
- 400: {
4164
- message?: string;
4165
- };
4166
- /**
4167
- * Insufficient permissions
4168
- */
4169
- 403: {
4170
- message?: string;
4171
- };
4172
- };
4173
- export type SettingsUpdateError = SettingsUpdateErrors[keyof SettingsUpdateErrors];
4174
- export type SettingsUpdateResponses = {
4175
- /**
4176
- * Success
4177
- */
4178
- 204: void;
4179
- };
4180
- export type SettingsUpdateResponse = SettingsUpdateResponses[keyof SettingsUpdateResponses];
4181
- export type StationsListData = {
4182
- body?: never;
4183
- path?: never;
4184
- query?: never;
4185
- url: '/stations';
4186
- };
4187
- export type StationsListErrors = {
4188
- /**
4189
- * Not permitted to access
4190
- */
4191
- 403: Forbidden;
4192
- };
4193
- export type StationsListError = StationsListErrors[keyof StationsListErrors];
4194
- export type StationsListResponses = {
4195
- /**
4196
- * Success
4197
- */
4198
- 200: Array<StationItem>;
4199
- };
4200
- export type StationsListResponse = StationsListResponses[keyof StationsListResponses];
4201
- export type StationsCreateData = {
4202
- body?: StationItemCreate;
4203
- path?: never;
4204
- query?: never;
4205
- url: '/stations';
4206
- };
4207
- export type StationsCreateErrors = {
4208
- /**
4209
- * Bad request
4210
- */
4211
- 400: {
4212
- status?: string;
4213
- message?: string;
4214
- data?: {
4215
- details?: string;
4216
- };
4217
- };
4218
- /**
4219
- * Not permitted to access
4220
- */
4221
- 403: Forbidden;
4222
- };
4223
- export type StationsCreateError = StationsCreateErrors[keyof StationsCreateErrors];
4224
- export type StationsCreateResponses = {
4225
- /**
4226
- * Success
4227
- */
4228
- 201: StationItemDetail;
4229
- };
4230
- export type StationsCreateResponse = StationsCreateResponses[keyof StationsCreateResponses];
4231
- export type StationDeleteData = {
4232
- body?: never;
4233
- path: {
4234
- /**
4235
- * Monitoring station id
4236
- */
4237
- id: number;
4238
- };
4239
- query?: never;
4240
- url: '/stations/{id}';
4241
- };
4242
- export type StationDeleteErrors = {
4243
- /**
4244
- * Not permitted to access
4245
- */
4246
- 403: Forbidden;
4247
- /**
4248
- * Monitoring station not found or insufficient privileges
4249
- */
4250
- 404: {
4251
- message?: string;
4252
- };
4253
- };
4254
- export type StationDeleteError = StationDeleteErrors[keyof StationDeleteErrors];
4255
- export type StationDeleteResponses = {
4256
- /**
4257
- * Success
4258
- */
4259
- 204: void;
4260
- };
4261
- export type StationDeleteResponse = StationDeleteResponses[keyof StationDeleteResponses];
4262
- export type StationsGetData = {
4263
- body?: never;
4264
- path: {
4265
- /**
4266
- * The station ID
4267
- */
4268
- id: number;
4269
- };
4270
- query?: never;
4271
- url: '/stations/{id}';
4272
- };
4273
- export type StationsGetErrors = {
4274
- /**
4275
- * Not permitted to access
4276
- */
4277
- 403: Forbidden;
4278
- /**
4279
- * Not found or not permitted to view
4280
- */
4281
- 404: {
4282
- message?: string;
4283
- };
4284
- };
4285
- export type StationsGetError = StationsGetErrors[keyof StationsGetErrors];
4286
- export type StationsGetResponses = {
4287
- /**
4288
- * Success
4289
- */
4290
- 200: StationItemDetail;
4291
- };
4292
- export type StationsGetResponse = StationsGetResponses[keyof StationsGetResponses];
4293
- export type StationsUpdateData = {
4294
- body?: StationItemCreate;
4295
- path: {
4296
- /**
4297
- * The ID of the station
4298
- */
4299
- id: number;
4300
- };
4301
- query?: never;
4302
- url: '/stations/{id}';
4303
- };
4304
- export type StationsUpdateErrors = {
4305
- /**
4306
- * Bad request
4307
- */
4308
- 400: {
4309
- status?: string;
4310
- message?: string;
4311
- data?: {
4312
- details?: string;
4313
- };
4314
- };
4315
- /**
4316
- * Not permitted to access
4317
- */
4318
- 403: Forbidden;
4319
- };
4320
- export type StationsUpdateError = StationsUpdateErrors[keyof StationsUpdateErrors];
4321
- export type StationsUpdateResponses = {
4322
- /**
4323
- * Success
4324
- */
4325
- 201: StationItemDetail;
4326
- };
4327
- export type StationsUpdateResponse = StationsUpdateResponses[keyof StationsUpdateResponses];
4328
- export type StationsDeleteMaintenanceData = {
4329
- body?: never;
4330
- path: {
4331
- /**
4332
- * The ID of the station
4333
- */
4334
- id: number;
4335
- };
4336
- query?: never;
4337
- url: '/stations/maintenance/{id}';
4338
- };
4339
- export type StationsDeleteMaintenanceErrors = {
4340
- /**
4341
- * Bad request
4342
- */
4343
- 400: {
4344
- status?: string;
4345
- message?: string;
4346
- data?: {
4347
- details?: string;
4348
- };
4349
- };
4350
- /**
4351
- * Not permitted to access
4352
- */
4353
- 403: Forbidden;
4354
- };
4355
- export type StationsDeleteMaintenanceError = StationsDeleteMaintenanceErrors[keyof StationsDeleteMaintenanceErrors];
4356
- export type StationsDeleteMaintenanceResponses = {
4357
- /**
4358
- * Success
4359
- */
4360
- 204: void;
4361
- };
4362
- export type StationsDeleteMaintenanceResponse = StationsDeleteMaintenanceResponses[keyof StationsDeleteMaintenanceResponses];
4363
- export type StationsPutMaintenanceData = {
4364
- body?: never;
4365
- path: {
4366
- /**
4367
- * The ID of the station
4368
- */
4369
- id: number;
4370
- };
4371
- query?: never;
4372
- url: '/stations/maintenance/{id}';
4373
- };
4374
- export type StationsPutMaintenanceErrors = {
4375
- /**
4376
- * Bad request
4377
- */
4378
- 400: {
4379
- status?: string;
4380
- message?: string;
4381
- data?: {
4382
- details?: string;
4383
- };
4384
- };
4385
- /**
4386
- * Not permitted to access
4387
- */
4388
- 403: Forbidden;
4389
- };
4390
- export type StationsPutMaintenanceError = StationsPutMaintenanceErrors[keyof StationsPutMaintenanceErrors];
4391
- export type StationsPutMaintenanceResponses = {
4392
- /**
4393
- * Success
4394
- */
4395
- 204: void;
4396
- };
4397
- export type StationsPutMaintenanceResponse = StationsPutMaintenanceResponses[keyof StationsPutMaintenanceResponses];
4398
- export type StationsOnpremiseListData = {
4399
- body?: never;
4400
- path?: never;
4401
- query?: never;
4402
- url: '/stations/onpremise';
4403
- };
4404
- export type StationsOnpremiseListErrors = {
4405
- /**
4406
- * Not permitted to access
4407
- */
4408
- 403: Forbidden;
4409
- };
4410
- export type StationsOnpremiseListError = StationsOnpremiseListErrors[keyof StationsOnpremiseListErrors];
4411
- export type StationsOnpremiseListResponses = {
4412
- /**
4413
- * Success
4414
- */
4415
- 200: Array<StationItem>;
4416
- };
4417
- export type StationsOnpremiseListResponse = StationsOnpremiseListResponses[keyof StationsOnpremiseListResponses];
4418
- export type StationsOnpremiseConnectedData = {
4419
- body?: never;
4420
- path?: never;
4421
- query?: never;
4422
- url: '/stations/onpremise/connected';
4423
- };
4424
- export type StationsOnpremiseConnectedErrors = {
4425
- /**
4426
- * Not permitted to access
4427
- */
4428
- 403: Forbidden;
4429
- };
4430
- export type StationsOnpremiseConnectedError = StationsOnpremiseConnectedErrors[keyof StationsOnpremiseConnectedErrors];
4431
- export type StationsOnpremiseConnectedResponses = {
4432
- /**
4433
- * Success
4434
- */
4435
- 200: Array<StationItem>;
4436
- };
4437
- export type StationsOnpremiseConnectedResponse = StationsOnpremiseConnectedResponses[keyof StationsOnpremiseConnectedResponses];
4438
- export type StationsOnpremiseConnectedAllData = {
4439
- body?: never;
4440
- path?: never;
4441
- query?: never;
4442
- url: '/stations/onpremise/connected/all';
4443
- };
4444
- export type StationsOnpremiseConnectedAllErrors = {
4445
- /**
4446
- * Not permitted to access
4447
- */
4448
- 403: Forbidden;
4449
- };
4450
- export type StationsOnpremiseConnectedAllError = StationsOnpremiseConnectedAllErrors[keyof StationsOnpremiseConnectedAllErrors];
4451
- export type StationsOnpremiseConnectedAllResponses = {
4452
- /**
4453
- * Success
4454
- */
4455
- 200: Array<StationItem>;
4456
- };
4457
- export type StationsOnpremiseConnectedAllResponse = StationsOnpremiseConnectedAllResponses[keyof StationsOnpremiseConnectedAllResponses];
4458
- export type StationsLatestData = {
4459
- body?: never;
4460
- path?: never;
4461
- query?: never;
4462
- url: '/stations/latest';
4463
- };
4464
- export type StationsLatestResponses = {
4465
- /**
4466
- * Success
4467
- */
4468
- 200: Array<StationLatest>;
4469
- };
4470
- export type StationsLatestResponse = StationsLatestResponses[keyof StationsLatestResponses];
4471
- export type StationsAgentTypeData = {
4472
- body?: never;
4473
- path: {
4474
- /**
4475
- * The new agent to use
4476
- */
4477
- agent: 'ccagent' | 'cbot';
4478
- /**
4479
- * The ID of the station
4480
- */
4481
- id: number;
4482
- };
4483
- query?: never;
4484
- url: '/stations/{agent}/{id}';
4485
- };
4486
- export type StationsAgentTypeErrors = {
4487
- /**
4488
- * Not permitted to access
4489
- */
4490
- 403: Forbidden;
4491
- /**
4492
- * Not found or not permitted to view
4493
- */
4494
- 404: {
4495
- message?: string;
4496
- };
4497
- };
4498
- export type StationsAgentTypeError = StationsAgentTypeErrors[keyof StationsAgentTypeErrors];
4499
- export type StationsAgentTypeResponses = {
4500
- /**
4501
- * Success
4502
- */
4503
- 204: void;
4504
- };
4505
- export type StationsAgentTypeResponse = StationsAgentTypeResponses[keyof StationsAgentTypeResponses];
4506
- export type StationsGetAgentsData = {
4507
- body?: never;
4508
- path: {
4509
- /**
4510
- * The ID of the station
4511
- */
4512
- id: number;
4513
- };
4514
- query?: never;
4515
- url: '/stations/agents/{id}';
4516
- };
4517
- export type StationsGetAgentsErrors = {
4518
- /**
4519
- * Not permitted to access
4520
- */
4521
- 403: Forbidden;
4522
- /**
4523
- * Not found or not permitted to view
4524
- */
4525
- 404: {
4526
- message?: string;
4527
- };
4528
- };
4529
- export type StationsGetAgentsError = StationsGetAgentsErrors[keyof StationsGetAgentsErrors];
4530
- export type StationsGetAgentsResponses = {
4531
- /**
4532
- * Success
4533
- */
4534
- 200: Array<StationAgent>;
4535
- };
4536
- export type StationsGetAgentsResponse = StationsGetAgentsResponses[keyof StationsGetAgentsResponses];
4537
- export type StatisticData = {
4538
- body?: never;
4539
- path?: never;
4540
- query: {
4541
- /**
4542
- * List of monitors to query. If both 'monitors' and 'folders' are omitted, query all monitors. Format: Monitor name (string) or monitor ID (integer).
4543
- */
4544
- monitor?: Array<string>;
4545
- /**
4546
- * List of folders to query. If both 'monitors' and 'folders' are omitted, query all monitors. Format: Folder name (string) or folder ID (integer).
4547
- */
4548
- folder?: Array<string>;
4549
- /**
4550
- * List of locations to filter by. Format: Location name (string) or location ID (integer).
4551
- */
4552
- location?: Array<string>;
4553
- /**
4554
- * Start of interval. Format: ISO 8601 date and time.
4555
- */
4556
- from: string;
4557
- /**
4558
- * End of interval. Format: ISO 8601 date and time. Default is the current time.
4559
- */
4560
- to?: string;
4561
- /**
4562
- * Return a time series with a given period between data points. Format: ISO 8601 duration. If omitted, return a single value.
4563
- */
4564
- period?: string;
4565
- /**
4566
- * Group results by monitor or location.
4567
- */
4568
- groupBy?: 'monitor' | 'location';
4569
- /**
4570
- * List of metrics to return. If omitted, return all metrics.
4571
- */
4572
- metric?: Array<string>;
4573
- };
4574
- url: '/statistic';
4575
- };
4576
- export type StatisticErrors = {
4577
- /**
4578
- * Bad request.
4579
- */
4580
- 400: unknown;
4581
- /**
4582
- * Not permitted to access
4583
- */
4584
- 403: Forbidden;
4585
- };
4586
- export type StatisticError = StatisticErrors[keyof StatisticErrors];
4587
- export type StatisticResponses = {
4588
- /**
4589
- * Success
4590
- */
4591
- 200: Array<StatisticItem>;
4592
- };
4593
- export type StatisticResponse = StatisticResponses[keyof StatisticResponses];
4594
- export type TagsGetAllData = {
4595
- body?: never;
4596
- path?: never;
4597
- query?: never;
4598
- url: '/tags';
4599
- };
4600
- export type TagsGetAllErrors = {
4601
- /**
4602
- * Access to the resource was denied.
4603
- */
4604
- 403: {
4605
- message?: string;
4606
- };
4607
- };
4608
- export type TagsGetAllError = TagsGetAllErrors[keyof TagsGetAllErrors];
4609
- export type TagsGetAllResponses = {
4610
- /**
4611
- * Success
4612
- */
4613
- 200: Array<MonitorTag>;
4614
- };
4615
- export type TagsGetAllResponse = TagsGetAllResponses[keyof TagsGetAllResponses];
4616
- export type TimezonesListData = {
4617
- body?: never;
4618
- path?: never;
4619
- query?: never;
4620
- url: '/timezones';
4621
- };
4622
- export type TimezonesListErrors = {
4623
- /**
4624
- * Access to the resource was denied.
4625
- */
4626
- 403: {
4627
- message?: string;
4628
- };
4629
- };
4630
- export type TimezonesListError = TimezonesListErrors[keyof TimezonesListErrors];
4631
- export type TimezonesListResponses = {
4632
- /**
4633
- * Success
4634
- */
4635
- 200: Array<TimezoneItem>;
4636
- };
4637
- export type TimezonesListResponse = TimezonesListResponses[keyof TimezonesListResponses];
4638
- export type UserGetData = {
4639
- body?: never;
4640
- path?: never;
4641
- query?: never;
4642
- url: '/user';
4643
- };
4644
- export type UserGetErrors = {
4645
- /**
4646
- * Not permitted to access
4647
- */
4648
- 403: Forbidden;
4649
- };
4650
- export type UserGetError = UserGetErrors[keyof UserGetErrors];
4651
- export type UserGetResponses = {
4652
- /**
4653
- * Success
4654
- */
4655
- 200: User;
4656
- };
4657
- export type UserGetResponse = UserGetResponses[keyof UserGetResponses];
4658
- export type UserSubaccountsGetData = {
4659
- body?: never;
4660
- path?: never;
4661
- query?: never;
4662
- url: '/user/subaccounts';
4663
- };
4664
- export type UserSubaccountsGetErrors = {
4665
- /**
4666
- * Not permitted to access
4667
- */
4668
- 403: Forbidden;
4669
- };
4670
- export type UserSubaccountsGetError = UserSubaccountsGetErrors[keyof UserSubaccountsGetErrors];
4671
- export type UserSubaccountsGetResponses = {
4672
- /**
4673
- * Success
4674
- */
4675
- 200: Array<User>;
4676
- };
4677
- export type UserSubaccountsGetResponse = UserSubaccountsGetResponses[keyof UserSubaccountsGetResponses];
4678
- export type UserSubaccountsPostData = {
4679
- /**
4680
- * User data
4681
- */
4682
- body: UserCreate;
4683
- path?: never;
4684
- query?: never;
4685
- url: '/user/subaccounts';
4686
- };
4687
- export type UserSubaccountsPostErrors = {
4688
- /**
4689
- * Bad request
4690
- */
4691
- 400: {
4692
- message?: string;
4693
- };
4694
- /**
4695
- * Not permitted to access
4696
- */
4697
- 403: Forbidden;
4698
- };
4699
- export type UserSubaccountsPostError = UserSubaccountsPostErrors[keyof UserSubaccountsPostErrors];
4700
- export type UserSubaccountsPostResponses = {
4701
- /**
4702
- * Success
4703
- */
4704
- 201: User;
4705
- };
4706
- export type UserSubaccountsPostResponse = UserSubaccountsPostResponses[keyof UserSubaccountsPostResponses];
4707
- export type UserBlockDeleteData = {
4708
- body?: never;
4709
- path: {
4710
- /**
4711
- * ID of the account to unblock
4712
- */
4713
- id: number;
4714
- };
4715
- query?: never;
4716
- url: '/user/block/{id}';
4717
- };
4718
- export type UserBlockDeleteErrors = {
4719
- /**
4720
- * Bad request
4721
- */
4722
- 400: {
4723
- message?: string;
4724
- };
4725
- /**
4726
- * Not permitted to access
4727
- */
4728
- 403: Forbidden;
4729
- };
4730
- export type UserBlockDeleteError = UserBlockDeleteErrors[keyof UserBlockDeleteErrors];
4731
- export type UserBlockDeleteResponses = {
4732
- /**
4733
- * Success
4734
- */
4735
- 200: unknown;
4736
- /**
4737
- * Not needed - account not blocked
4738
- */
4739
- 204: void;
4740
- };
4741
- export type UserBlockDeleteResponse = UserBlockDeleteResponses[keyof UserBlockDeleteResponses];
4742
- export type UserBlockPutData = {
4743
- body?: never;
4744
- path: {
4745
- /**
4746
- * ID of the account to block
4747
- */
4748
- id: number;
4749
- };
4750
- query?: never;
4751
- url: '/user/block/{id}';
4752
- };
4753
- export type UserBlockPutErrors = {
4754
- /**
4755
- * Bad request
4756
- */
4757
- 400: {
4758
- message?: string;
4759
- };
4760
- /**
4761
- * Not permitted to access
4762
- */
4763
- 403: Forbidden;
4764
- };
4765
- export type UserBlockPutError = UserBlockPutErrors[keyof UserBlockPutErrors];
4766
- export type UserBlockPutResponses = {
4767
- /**
4768
- * Success
4769
- */
4770
- 200: unknown;
4771
- /**
4772
- * Not needed - account already blocked
4773
- */
4774
- 204: void;
4775
- };
4776
- export type UserBlockPutResponse = UserBlockPutResponses[keyof UserBlockPutResponses];
4777
- export type UserLockDeleteData = {
4778
- body?: never;
4779
- path: {
4780
- /**
4781
- * ID of the account to unlock
4782
- */
4783
- id: number;
4784
- };
4785
- query?: never;
4786
- url: '/user/lock/{id}';
4787
- };
4788
- export type UserLockDeleteErrors = {
4789
- /**
4790
- * Bad request
4791
- */
4792
- 400: {
4793
- message?: string;
4794
- };
4795
- /**
4796
- * Not permitted to access
4797
- */
4798
- 403: Forbidden;
4799
- };
4800
- export type UserLockDeleteError = UserLockDeleteErrors[keyof UserLockDeleteErrors];
4801
- export type UserLockDeleteResponses = {
4802
- /**
4803
- * Success
4804
- */
4805
- 200: unknown;
4806
- /**
4807
- * Not needed - account not locked
4808
- */
4809
- 204: void;
4810
- };
4811
- export type UserLockDeleteResponse = UserLockDeleteResponses[keyof UserLockDeleteResponses];
4812
- export type UserDeleteData = {
4813
- body?: never;
4814
- path: {
4815
- /**
4816
- * ID of the account to remove
4817
- */
4818
- id: number;
4819
- };
4820
- query?: never;
4821
- url: '/user/{id}';
4822
- };
4823
- export type UserDeleteErrors = {
4824
- /**
4825
- * Bad request
4826
- */
4827
- 400: {
4828
- message?: string;
4829
- };
4830
- /**
4831
- * Not permitted to access
4832
- */
4833
- 403: Forbidden;
4834
- };
4835
- export type UserDeleteError = UserDeleteErrors[keyof UserDeleteErrors];
4836
- export type UserDeleteResponses = {
4837
- /**
4838
- * Success
4839
- */
4840
- 204: void;
4841
- };
4842
- export type UserDeleteResponse = UserDeleteResponses[keyof UserDeleteResponses];
4843
- export type UserPutData = {
4844
- /**
4845
- * User data
4846
- */
4847
- body: UserCreate;
4848
- path: {
4849
- /**
4850
- * The ID of the account
4851
- */
4852
- id: number;
4853
- };
4854
- query?: never;
4855
- url: '/user/{id}';
4856
- };
4857
- export type UserPutErrors = {
4858
- /**
4859
- * Bad request
4860
- */
4861
- 400: {
4862
- message?: string;
4863
- };
4864
- /**
4865
- * Not permitted to access
4866
- */
4867
- 403: Forbidden;
4868
- };
4869
- export type UserPutError = UserPutErrors[keyof UserPutErrors];
4870
- export type UserPutResponses = {
4871
- /**
4872
- * Success
4873
- */
4874
- 201: User;
4875
- };
4876
- export type UserPutResponse = UserPutResponses[keyof UserPutResponses];
4877
- //# sourceMappingURL=types.gen.d.ts.map