@checkly/pulumi 0.0.1-alpha.4 → 0.0.1-alpha.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -3
- package/alertChannel.ts +55 -138
- package/bin/README.md +58 -15
- package/bin/alertChannel.d.ts +55 -138
- package/bin/alertChannel.js +40 -105
- package/bin/alertChannel.js.map +1 -1
- package/bin/check.d.ts +90 -51
- package/bin/check.js +3 -0
- package/bin/check.js.map +1 -1
- package/bin/checkGroup.d.ts +112 -36
- package/bin/checkGroup.js +88 -0
- package/bin/checkGroup.js.map +1 -1
- package/bin/dashboard.d.ts +125 -14
- package/bin/dashboard.js +21 -21
- package/bin/dashboard.js.map +1 -1
- package/bin/environmentVariable.d.ts +64 -0
- package/bin/environmentVariable.js +78 -0
- package/bin/environmentVariable.js.map +1 -0
- package/bin/index.d.ts +1 -0
- package/bin/index.js +5 -0
- package/bin/index.js.map +1 -1
- package/bin/maintenanceWindow.d.ts +16 -36
- package/bin/maintenanceWindow.js +1 -30
- package/bin/maintenanceWindow.js.map +1 -1
- package/bin/package.json +3 -3
- package/bin/snippet.d.ts +3 -3
- package/bin/triggerCheck.d.ts +18 -6
- package/bin/triggerCheck.js +0 -6
- package/bin/triggerCheck.js.map +1 -1
- package/bin/triggerCheckGroup.d.ts +18 -6
- package/bin/triggerCheckGroup.js +0 -6
- package/bin/triggerCheckGroup.js.map +1 -1
- package/bin/types/input.d.ts +2 -188
- package/bin/types/input.js.map +1 -1
- package/bin/types/output.d.ts +2 -188
- package/bin/types/output.js.map +1 -1
- package/bin/yarn.lock +179 -117
- package/check.ts +90 -51
- package/checkGroup.ts +112 -36
- package/dashboard.ts +125 -35
- package/environmentVariable.ts +107 -0
- package/index.ts +5 -0
- package/maintenanceWindow.ts +16 -45
- package/package.json +29 -29
- package/snippet.ts +3 -3
- package/triggerCheck.ts +18 -6
- package/triggerCheckGroup.ts +18 -6
- package/tsconfig.json +1 -0
- package/types/input.ts +2 -188
- package/types/output.ts +2 -188
package/bin/types/input.d.ts
CHANGED
|
@@ -1,243 +1,105 @@
|
|
|
1
1
|
import * as pulumi from "@pulumi/pulumi";
|
|
2
2
|
import { input as inputs } from "../types";
|
|
3
3
|
export interface AlertChannelEmail {
|
|
4
|
-
/**
|
|
5
|
-
* the email address of this email alert channel.
|
|
6
|
-
*/
|
|
7
4
|
address: pulumi.Input<string>;
|
|
8
5
|
}
|
|
9
6
|
export interface AlertChannelOpsgenie {
|
|
10
|
-
/**
|
|
11
|
-
* .
|
|
12
|
-
*/
|
|
13
7
|
apiKey: pulumi.Input<string>;
|
|
14
|
-
/**
|
|
15
|
-
* Webhook's channel name.
|
|
16
|
-
*/
|
|
17
8
|
name: pulumi.Input<string>;
|
|
18
|
-
/**
|
|
19
|
-
* .
|
|
20
|
-
*/
|
|
21
9
|
priority: pulumi.Input<string>;
|
|
22
|
-
/**
|
|
23
|
-
* .
|
|
24
|
-
*/
|
|
25
10
|
region: pulumi.Input<string>;
|
|
26
11
|
}
|
|
27
12
|
export interface AlertChannelPagerduty {
|
|
28
|
-
/**
|
|
29
|
-
* Pagerduty's account name.
|
|
30
|
-
*/
|
|
31
13
|
account?: pulumi.Input<string>;
|
|
32
|
-
/**
|
|
33
|
-
* Pagerduty's service integration key.
|
|
34
|
-
*/
|
|
35
14
|
serviceKey: pulumi.Input<string>;
|
|
36
|
-
/**
|
|
37
|
-
* Pagerduty's service name.
|
|
38
|
-
*/
|
|
39
15
|
serviceName?: pulumi.Input<string>;
|
|
40
16
|
}
|
|
41
17
|
export interface AlertChannelSlack {
|
|
42
|
-
/**
|
|
43
|
-
* Slack's channel name.
|
|
44
|
-
*/
|
|
45
18
|
channel: pulumi.Input<string>;
|
|
46
|
-
/**
|
|
47
|
-
* .
|
|
48
|
-
*/
|
|
49
19
|
url: pulumi.Input<string>;
|
|
50
20
|
}
|
|
51
21
|
export interface AlertChannelSms {
|
|
52
|
-
/**
|
|
53
|
-
* Webhook's channel name.
|
|
54
|
-
*/
|
|
55
22
|
name: pulumi.Input<string>;
|
|
56
|
-
/**
|
|
57
|
-
* Mobile number to receive alerts.
|
|
58
|
-
*/
|
|
59
23
|
number: pulumi.Input<string>;
|
|
60
24
|
}
|
|
61
25
|
export interface AlertChannelWebhook {
|
|
62
|
-
/**
|
|
63
|
-
* .
|
|
64
|
-
*/
|
|
65
26
|
headers?: pulumi.Input<{
|
|
66
27
|
[key: string]: any;
|
|
67
28
|
}>;
|
|
68
|
-
/**
|
|
69
|
-
* Default is `POST`.
|
|
70
|
-
*/
|
|
71
29
|
method?: pulumi.Input<string>;
|
|
72
|
-
/**
|
|
73
|
-
* Webhook's channel name.
|
|
74
|
-
*/
|
|
75
30
|
name: pulumi.Input<string>;
|
|
76
|
-
/**
|
|
77
|
-
* .
|
|
78
|
-
*/
|
|
79
31
|
queryParameters?: pulumi.Input<{
|
|
80
32
|
[key: string]: any;
|
|
81
33
|
}>;
|
|
82
|
-
/**
|
|
83
|
-
* .
|
|
84
|
-
*/
|
|
85
34
|
template?: pulumi.Input<string>;
|
|
86
|
-
/**
|
|
87
|
-
* .
|
|
88
|
-
*/
|
|
89
35
|
url: pulumi.Input<string>;
|
|
90
|
-
/**
|
|
91
|
-
* .
|
|
92
|
-
*/
|
|
93
36
|
webhookSecret?: pulumi.Input<string>;
|
|
94
37
|
}
|
|
95
38
|
export interface CheckAlertChannelSubscription {
|
|
96
|
-
/**
|
|
97
|
-
* Determines if the check is running or not. Possible values `true`, and `false`.
|
|
98
|
-
*/
|
|
99
39
|
activated: pulumi.Input<boolean>;
|
|
100
40
|
channelId: pulumi.Input<number>;
|
|
101
41
|
}
|
|
102
42
|
export interface CheckAlertSettings {
|
|
103
|
-
/**
|
|
104
|
-
* Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
|
|
105
|
-
*/
|
|
106
43
|
escalationType?: pulumi.Input<string>;
|
|
107
|
-
/**
|
|
108
|
-
* . Possible arguments:
|
|
109
|
-
*/
|
|
110
44
|
reminders?: pulumi.Input<pulumi.Input<inputs.CheckAlertSettingsReminder>[]>;
|
|
111
|
-
/**
|
|
112
|
-
* . Possible arguments:
|
|
113
|
-
*/
|
|
114
45
|
runBasedEscalations?: pulumi.Input<pulumi.Input<inputs.CheckAlertSettingsRunBasedEscalation>[]>;
|
|
115
46
|
/**
|
|
116
|
-
*
|
|
47
|
+
* @deprecated The property `ssl_certificates` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.
|
|
117
48
|
*/
|
|
118
49
|
sslCertificates?: pulumi.Input<pulumi.Input<inputs.CheckAlertSettingsSslCertificate>[]>;
|
|
119
|
-
/**
|
|
120
|
-
* . Possible arguments:
|
|
121
|
-
*/
|
|
122
50
|
timeBasedEscalations?: pulumi.Input<pulumi.Input<inputs.CheckAlertSettingsTimeBasedEscalation>[]>;
|
|
123
51
|
}
|
|
124
52
|
export interface CheckAlertSettingsReminder {
|
|
125
|
-
/**
|
|
126
|
-
* How many reminders to send out after the initial alert notification. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000`
|
|
127
|
-
*/
|
|
128
53
|
amount?: pulumi.Input<number>;
|
|
129
|
-
/**
|
|
130
|
-
* . Possible values are `5`, `10`, `15`, and `30`. Defaults to `5`.
|
|
131
|
-
*/
|
|
132
54
|
interval?: pulumi.Input<number>;
|
|
133
55
|
}
|
|
134
56
|
export interface CheckAlertSettingsRunBasedEscalation {
|
|
135
|
-
/**
|
|
136
|
-
* After how many failed consecutive check runs an alert notification should be send. Possible values are between 1 and 5. Defaults to `1`.
|
|
137
|
-
*/
|
|
138
57
|
failedRunThreshold?: pulumi.Input<number>;
|
|
139
58
|
}
|
|
140
59
|
export interface CheckAlertSettingsSslCertificate {
|
|
141
|
-
/**
|
|
142
|
-
* At what moment in time to start alerting on SSL certificates. Possible values `3`, `7`, `14`, `30`. Defaults to `3`.
|
|
143
|
-
*/
|
|
144
60
|
alertThreshold?: pulumi.Input<number>;
|
|
145
|
-
/**
|
|
146
|
-
* Determines if alert notifications should be send for expiring SSL certificates. Possible values `true`, and `false`. Defaults to `true`.
|
|
147
|
-
*/
|
|
148
61
|
enabled?: pulumi.Input<boolean>;
|
|
149
62
|
}
|
|
150
63
|
export interface CheckAlertSettingsTimeBasedEscalation {
|
|
151
|
-
/**
|
|
152
|
-
* After how many minutes after a check starts failing an alert should be send. Possible values are `5`, `10`, `15`, and `30`. Defaults to `5`.
|
|
153
|
-
*/
|
|
154
64
|
minutesFailingThreshold?: pulumi.Input<number>;
|
|
155
65
|
}
|
|
156
66
|
export interface CheckGroupAlertChannelSubscription {
|
|
157
|
-
/**
|
|
158
|
-
* Determines if the checks in the group are running or not.
|
|
159
|
-
*/
|
|
160
67
|
activated: pulumi.Input<boolean>;
|
|
161
68
|
channelId: pulumi.Input<number>;
|
|
162
69
|
}
|
|
163
70
|
export interface CheckGroupAlertSettings {
|
|
164
|
-
/**
|
|
165
|
-
* Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
|
|
166
|
-
*/
|
|
167
71
|
escalationType?: pulumi.Input<string>;
|
|
168
|
-
/**
|
|
169
|
-
* . Possible arguments:
|
|
170
|
-
*/
|
|
171
72
|
reminders?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertSettingsReminder>[]>;
|
|
172
|
-
/**
|
|
173
|
-
* . Possible arguments:
|
|
174
|
-
*/
|
|
175
73
|
runBasedEscalations?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertSettingsRunBasedEscalation>[]>;
|
|
176
74
|
/**
|
|
177
|
-
*
|
|
75
|
+
* @deprecated The property `ssl_certificates` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.
|
|
178
76
|
*/
|
|
179
77
|
sslCertificates?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertSettingsSslCertificate>[]>;
|
|
180
|
-
/**
|
|
181
|
-
* . Possible arguments:
|
|
182
|
-
*/
|
|
183
78
|
timeBasedEscalations?: pulumi.Input<pulumi.Input<inputs.CheckGroupAlertSettingsTimeBasedEscalation>[]>;
|
|
184
79
|
}
|
|
185
80
|
export interface CheckGroupAlertSettingsReminder {
|
|
186
|
-
/**
|
|
187
|
-
* How many reminders to send out after the initial alert notification. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000`
|
|
188
|
-
*/
|
|
189
81
|
amount?: pulumi.Input<number>;
|
|
190
|
-
/**
|
|
191
|
-
* . Possible values are `5`, `10`, `15`, and `30`. Defaults to `5`.
|
|
192
|
-
*/
|
|
193
82
|
interval?: pulumi.Input<number>;
|
|
194
83
|
}
|
|
195
84
|
export interface CheckGroupAlertSettingsRunBasedEscalation {
|
|
196
|
-
/**
|
|
197
|
-
* After how many failed consecutive check runs an alert notification should be send. Possible values are between 1 and 5. Defaults to `1`.
|
|
198
|
-
*/
|
|
199
85
|
failedRunThreshold?: pulumi.Input<number>;
|
|
200
86
|
}
|
|
201
87
|
export interface CheckGroupAlertSettingsSslCertificate {
|
|
202
|
-
/**
|
|
203
|
-
* At what moment in time to start alerting on SSL certificates. Possible values `3`, `7`, `14`, `30`. Defaults to `3`.
|
|
204
|
-
*/
|
|
205
88
|
alertThreshold?: pulumi.Input<number>;
|
|
206
|
-
/**
|
|
207
|
-
* Determines if alert notifications should be send for expiring SSL certificates. Possible values `true`, and `false`. Defaults to `true`.
|
|
208
|
-
*/
|
|
209
89
|
enabled?: pulumi.Input<boolean>;
|
|
210
90
|
}
|
|
211
91
|
export interface CheckGroupAlertSettingsTimeBasedEscalation {
|
|
212
|
-
/**
|
|
213
|
-
* After how many minutes after a check starts failing an alert should be send. Possible values are `5`, `10`, `15`, and `30`. Defaults to `5`.
|
|
214
|
-
*/
|
|
215
92
|
minutesFailingThreshold?: pulumi.Input<number>;
|
|
216
93
|
}
|
|
217
94
|
export interface CheckGroupApiCheckDefaults {
|
|
218
|
-
/**
|
|
219
|
-
* . Possible arguments:
|
|
220
|
-
*/
|
|
221
95
|
assertions?: pulumi.Input<pulumi.Input<inputs.CheckGroupApiCheckDefaultsAssertion>[]>;
|
|
222
|
-
/**
|
|
223
|
-
* . Possible arguments
|
|
224
|
-
*/
|
|
225
96
|
basicAuth?: pulumi.Input<inputs.CheckGroupApiCheckDefaultsBasicAuth>;
|
|
226
|
-
/**
|
|
227
|
-
* .
|
|
228
|
-
*/
|
|
229
97
|
headers?: pulumi.Input<{
|
|
230
98
|
[key: string]: any;
|
|
231
99
|
}>;
|
|
232
|
-
/**
|
|
233
|
-
* .
|
|
234
|
-
*/
|
|
235
100
|
queryParameters?: pulumi.Input<{
|
|
236
101
|
[key: string]: any;
|
|
237
102
|
}>;
|
|
238
|
-
/**
|
|
239
|
-
* The base url for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks.
|
|
240
|
-
*/
|
|
241
103
|
url?: pulumi.Input<string>;
|
|
242
104
|
}
|
|
243
105
|
/**
|
|
@@ -245,17 +107,8 @@ export interface CheckGroupApiCheckDefaults {
|
|
|
245
107
|
*/
|
|
246
108
|
export declare function checkGroupApiCheckDefaultsProvideDefaults(val: CheckGroupApiCheckDefaults): CheckGroupApiCheckDefaults;
|
|
247
109
|
export interface CheckGroupApiCheckDefaultsAssertion {
|
|
248
|
-
/**
|
|
249
|
-
* Possible values `EQUALS`, `NOT_EQUALS`, `HAS_KEY`, `NOT_HAS_KEY`, `HAS_VALUE`, `NOT_HAS_VALUE`, `IS_EMPTY`, `NOT_EMPTY`, `GREATER_THAN`, `LESS_THAN`, `CONTAINS`, `NOT_CONTAINS`, `IS_NULL`, and `NOT_NULL`.
|
|
250
|
-
*/
|
|
251
110
|
comparison: pulumi.Input<string>;
|
|
252
|
-
/**
|
|
253
|
-
* .
|
|
254
|
-
*/
|
|
255
111
|
property?: pulumi.Input<string>;
|
|
256
|
-
/**
|
|
257
|
-
* Possible values `STATUS_CODE`, `JSON_BODY`, `HEADERS`, `TEXT_BODY`, and `RESPONSE_TIME`.
|
|
258
|
-
*/
|
|
259
112
|
source: pulumi.Input<string>;
|
|
260
113
|
target: pulumi.Input<string>;
|
|
261
114
|
}
|
|
@@ -264,64 +117,25 @@ export interface CheckGroupApiCheckDefaultsBasicAuth {
|
|
|
264
117
|
username: pulumi.Input<string>;
|
|
265
118
|
}
|
|
266
119
|
export interface CheckRequest {
|
|
267
|
-
/**
|
|
268
|
-
* A request can have multiple assetions. Assertion has the following arguments:
|
|
269
|
-
*/
|
|
270
120
|
assertions?: pulumi.Input<pulumi.Input<inputs.CheckRequestAssertion>[]>;
|
|
271
|
-
/**
|
|
272
|
-
* A request might have one basicAuth config. basicAuth has two arguments:
|
|
273
|
-
*/
|
|
274
121
|
basicAuth?: pulumi.Input<inputs.CheckRequestBasicAuth>;
|
|
275
122
|
body?: pulumi.Input<string>;
|
|
276
|
-
/**
|
|
277
|
-
* Possible values `NONE`, `JSON`, `FORM`, `RAW`, and `GRAPHQL`.
|
|
278
|
-
*/
|
|
279
123
|
bodyType?: pulumi.Input<string>;
|
|
280
|
-
/**
|
|
281
|
-
* .
|
|
282
|
-
*/
|
|
283
124
|
followRedirects?: pulumi.Input<boolean>;
|
|
284
|
-
/**
|
|
285
|
-
* .
|
|
286
|
-
*/
|
|
287
125
|
headers?: pulumi.Input<{
|
|
288
126
|
[key: string]: any;
|
|
289
127
|
}>;
|
|
290
|
-
/**
|
|
291
|
-
* The HTTP method to use for this API check. Possible values are `GET`, `POST`, `PUT`, `HEAD`, `DELETE`, `PATCH`. Defaults to `GET`.
|
|
292
|
-
*/
|
|
293
128
|
method?: pulumi.Input<string>;
|
|
294
|
-
/**
|
|
295
|
-
* .
|
|
296
|
-
*/
|
|
297
129
|
queryParameters?: pulumi.Input<{
|
|
298
130
|
[key: string]: any;
|
|
299
131
|
}>;
|
|
300
|
-
/**
|
|
301
|
-
* .
|
|
302
|
-
*/
|
|
303
132
|
skipSsl?: pulumi.Input<boolean>;
|
|
304
|
-
/**
|
|
305
|
-
* .
|
|
306
|
-
*/
|
|
307
133
|
url: pulumi.Input<string>;
|
|
308
134
|
}
|
|
309
135
|
export interface CheckRequestAssertion {
|
|
310
|
-
/**
|
|
311
|
-
* Possible values `EQUALS`, `NOT_EQUALS`, `HAS_KEY`, `NOT_HAS_KEY`, `HAS_VALUE`, `NOT_HAS_VALUE`, `IS_EMPTY`, `NOT_EMPTY`, `GREATER_THAN`, `LESS_THAN`, `CONTAINS`, `NOT_CONTAINS`, `IS_NULL`, and `NOT_NULL`.
|
|
312
|
-
*/
|
|
313
136
|
comparison: pulumi.Input<string>;
|
|
314
|
-
/**
|
|
315
|
-
* .
|
|
316
|
-
*/
|
|
317
137
|
property?: pulumi.Input<string>;
|
|
318
|
-
/**
|
|
319
|
-
* Possible values `STATUS_CODE`, `JSON_BODY`, `HEADERS`, `TEXT_BODY`, and `RESPONSE_TIME`.
|
|
320
|
-
*/
|
|
321
138
|
source: pulumi.Input<string>;
|
|
322
|
-
/**
|
|
323
|
-
* .
|
|
324
|
-
*/
|
|
325
139
|
target?: pulumi.Input<string>;
|
|
326
140
|
}
|
|
327
141
|
export interface CheckRequestBasicAuth {
|
package/bin/types/input.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"input.js","sourceRoot":"","sources":["../../types/input.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;
|
|
1
|
+
{"version":3,"file":"input.js","sourceRoot":"","sources":["../../types/input.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAuHjF;;GAEG;AACH,SAAgB,yCAAyC,CAAC,GAA+B;;IACrF,uCACO,GAAG,KACN,GAAG,EAAE,MAAA,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,EAAE,IACtB;AACN,CAAC;AALD,8FAKC"}
|
package/bin/types/output.d.ts
CHANGED
|
@@ -1,242 +1,104 @@
|
|
|
1
1
|
import { output as outputs } from "../types";
|
|
2
2
|
export interface AlertChannelEmail {
|
|
3
|
-
/**
|
|
4
|
-
* the email address of this email alert channel.
|
|
5
|
-
*/
|
|
6
3
|
address: string;
|
|
7
4
|
}
|
|
8
5
|
export interface AlertChannelOpsgenie {
|
|
9
|
-
/**
|
|
10
|
-
* .
|
|
11
|
-
*/
|
|
12
6
|
apiKey: string;
|
|
13
|
-
/**
|
|
14
|
-
* Webhook's channel name.
|
|
15
|
-
*/
|
|
16
7
|
name: string;
|
|
17
|
-
/**
|
|
18
|
-
* .
|
|
19
|
-
*/
|
|
20
8
|
priority: string;
|
|
21
|
-
/**
|
|
22
|
-
* .
|
|
23
|
-
*/
|
|
24
9
|
region: string;
|
|
25
10
|
}
|
|
26
11
|
export interface AlertChannelPagerduty {
|
|
27
|
-
/**
|
|
28
|
-
* Pagerduty's account name.
|
|
29
|
-
*/
|
|
30
12
|
account?: string;
|
|
31
|
-
/**
|
|
32
|
-
* Pagerduty's service integration key.
|
|
33
|
-
*/
|
|
34
13
|
serviceKey: string;
|
|
35
|
-
/**
|
|
36
|
-
* Pagerduty's service name.
|
|
37
|
-
*/
|
|
38
14
|
serviceName?: string;
|
|
39
15
|
}
|
|
40
16
|
export interface AlertChannelSlack {
|
|
41
|
-
/**
|
|
42
|
-
* Slack's channel name.
|
|
43
|
-
*/
|
|
44
17
|
channel: string;
|
|
45
|
-
/**
|
|
46
|
-
* .
|
|
47
|
-
*/
|
|
48
18
|
url: string;
|
|
49
19
|
}
|
|
50
20
|
export interface AlertChannelSms {
|
|
51
|
-
/**
|
|
52
|
-
* Webhook's channel name.
|
|
53
|
-
*/
|
|
54
21
|
name: string;
|
|
55
|
-
/**
|
|
56
|
-
* Mobile number to receive alerts.
|
|
57
|
-
*/
|
|
58
22
|
number: string;
|
|
59
23
|
}
|
|
60
24
|
export interface AlertChannelWebhook {
|
|
61
|
-
/**
|
|
62
|
-
* .
|
|
63
|
-
*/
|
|
64
25
|
headers: {
|
|
65
26
|
[key: string]: any;
|
|
66
27
|
};
|
|
67
|
-
/**
|
|
68
|
-
* Default is `POST`.
|
|
69
|
-
*/
|
|
70
28
|
method?: string;
|
|
71
|
-
/**
|
|
72
|
-
* Webhook's channel name.
|
|
73
|
-
*/
|
|
74
29
|
name: string;
|
|
75
|
-
/**
|
|
76
|
-
* .
|
|
77
|
-
*/
|
|
78
30
|
queryParameters: {
|
|
79
31
|
[key: string]: any;
|
|
80
32
|
};
|
|
81
|
-
/**
|
|
82
|
-
* .
|
|
83
|
-
*/
|
|
84
33
|
template?: string;
|
|
85
|
-
/**
|
|
86
|
-
* .
|
|
87
|
-
*/
|
|
88
34
|
url: string;
|
|
89
|
-
/**
|
|
90
|
-
* .
|
|
91
|
-
*/
|
|
92
35
|
webhookSecret?: string;
|
|
93
36
|
}
|
|
94
37
|
export interface CheckAlertChannelSubscription {
|
|
95
|
-
/**
|
|
96
|
-
* Determines if the check is running or not. Possible values `true`, and `false`.
|
|
97
|
-
*/
|
|
98
38
|
activated: boolean;
|
|
99
39
|
channelId: number;
|
|
100
40
|
}
|
|
101
41
|
export interface CheckAlertSettings {
|
|
102
|
-
/**
|
|
103
|
-
* Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
|
|
104
|
-
*/
|
|
105
42
|
escalationType?: string;
|
|
106
|
-
/**
|
|
107
|
-
* . Possible arguments:
|
|
108
|
-
*/
|
|
109
43
|
reminders?: outputs.CheckAlertSettingsReminder[];
|
|
110
|
-
/**
|
|
111
|
-
* . Possible arguments:
|
|
112
|
-
*/
|
|
113
44
|
runBasedEscalations?: outputs.CheckAlertSettingsRunBasedEscalation[];
|
|
114
45
|
/**
|
|
115
|
-
*
|
|
46
|
+
* @deprecated The property `ssl_certificates` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.
|
|
116
47
|
*/
|
|
117
48
|
sslCertificates?: outputs.CheckAlertSettingsSslCertificate[];
|
|
118
|
-
/**
|
|
119
|
-
* . Possible arguments:
|
|
120
|
-
*/
|
|
121
49
|
timeBasedEscalations?: outputs.CheckAlertSettingsTimeBasedEscalation[];
|
|
122
50
|
}
|
|
123
51
|
export interface CheckAlertSettingsReminder {
|
|
124
|
-
/**
|
|
125
|
-
* How many reminders to send out after the initial alert notification. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000`
|
|
126
|
-
*/
|
|
127
52
|
amount?: number;
|
|
128
|
-
/**
|
|
129
|
-
* . Possible values are `5`, `10`, `15`, and `30`. Defaults to `5`.
|
|
130
|
-
*/
|
|
131
53
|
interval?: number;
|
|
132
54
|
}
|
|
133
55
|
export interface CheckAlertSettingsRunBasedEscalation {
|
|
134
|
-
/**
|
|
135
|
-
* After how many failed consecutive check runs an alert notification should be send. Possible values are between 1 and 5. Defaults to `1`.
|
|
136
|
-
*/
|
|
137
56
|
failedRunThreshold?: number;
|
|
138
57
|
}
|
|
139
58
|
export interface CheckAlertSettingsSslCertificate {
|
|
140
|
-
/**
|
|
141
|
-
* At what moment in time to start alerting on SSL certificates. Possible values `3`, `7`, `14`, `30`. Defaults to `3`.
|
|
142
|
-
*/
|
|
143
59
|
alertThreshold?: number;
|
|
144
|
-
/**
|
|
145
|
-
* Determines if alert notifications should be send for expiring SSL certificates. Possible values `true`, and `false`. Defaults to `true`.
|
|
146
|
-
*/
|
|
147
60
|
enabled?: boolean;
|
|
148
61
|
}
|
|
149
62
|
export interface CheckAlertSettingsTimeBasedEscalation {
|
|
150
|
-
/**
|
|
151
|
-
* After how many minutes after a check starts failing an alert should be send. Possible values are `5`, `10`, `15`, and `30`. Defaults to `5`.
|
|
152
|
-
*/
|
|
153
63
|
minutesFailingThreshold?: number;
|
|
154
64
|
}
|
|
155
65
|
export interface CheckGroupAlertChannelSubscription {
|
|
156
|
-
/**
|
|
157
|
-
* Determines if the checks in the group are running or not.
|
|
158
|
-
*/
|
|
159
66
|
activated: boolean;
|
|
160
67
|
channelId: number;
|
|
161
68
|
}
|
|
162
69
|
export interface CheckGroupAlertSettings {
|
|
163
|
-
/**
|
|
164
|
-
* Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
|
|
165
|
-
*/
|
|
166
70
|
escalationType?: string;
|
|
167
|
-
/**
|
|
168
|
-
* . Possible arguments:
|
|
169
|
-
*/
|
|
170
71
|
reminders?: outputs.CheckGroupAlertSettingsReminder[];
|
|
171
|
-
/**
|
|
172
|
-
* . Possible arguments:
|
|
173
|
-
*/
|
|
174
72
|
runBasedEscalations?: outputs.CheckGroupAlertSettingsRunBasedEscalation[];
|
|
175
73
|
/**
|
|
176
|
-
*
|
|
74
|
+
* @deprecated The property `ssl_certificates` is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.
|
|
177
75
|
*/
|
|
178
76
|
sslCertificates?: outputs.CheckGroupAlertSettingsSslCertificate[];
|
|
179
|
-
/**
|
|
180
|
-
* . Possible arguments:
|
|
181
|
-
*/
|
|
182
77
|
timeBasedEscalations?: outputs.CheckGroupAlertSettingsTimeBasedEscalation[];
|
|
183
78
|
}
|
|
184
79
|
export interface CheckGroupAlertSettingsReminder {
|
|
185
|
-
/**
|
|
186
|
-
* How many reminders to send out after the initial alert notification. Possible values are `0`, `1`, `2`, `3`, `4`, `5`, and `100000`
|
|
187
|
-
*/
|
|
188
80
|
amount?: number;
|
|
189
|
-
/**
|
|
190
|
-
* . Possible values are `5`, `10`, `15`, and `30`. Defaults to `5`.
|
|
191
|
-
*/
|
|
192
81
|
interval?: number;
|
|
193
82
|
}
|
|
194
83
|
export interface CheckGroupAlertSettingsRunBasedEscalation {
|
|
195
|
-
/**
|
|
196
|
-
* After how many failed consecutive check runs an alert notification should be send. Possible values are between 1 and 5. Defaults to `1`.
|
|
197
|
-
*/
|
|
198
84
|
failedRunThreshold?: number;
|
|
199
85
|
}
|
|
200
86
|
export interface CheckGroupAlertSettingsSslCertificate {
|
|
201
|
-
/**
|
|
202
|
-
* At what moment in time to start alerting on SSL certificates. Possible values `3`, `7`, `14`, `30`. Defaults to `3`.
|
|
203
|
-
*/
|
|
204
87
|
alertThreshold?: number;
|
|
205
|
-
/**
|
|
206
|
-
* Determines if alert notifications should be send for expiring SSL certificates. Possible values `true`, and `false`. Defaults to `true`.
|
|
207
|
-
*/
|
|
208
88
|
enabled?: boolean;
|
|
209
89
|
}
|
|
210
90
|
export interface CheckGroupAlertSettingsTimeBasedEscalation {
|
|
211
|
-
/**
|
|
212
|
-
* After how many minutes after a check starts failing an alert should be send. Possible values are `5`, `10`, `15`, and `30`. Defaults to `5`.
|
|
213
|
-
*/
|
|
214
91
|
minutesFailingThreshold?: number;
|
|
215
92
|
}
|
|
216
93
|
export interface CheckGroupApiCheckDefaults {
|
|
217
|
-
/**
|
|
218
|
-
* . Possible arguments:
|
|
219
|
-
*/
|
|
220
94
|
assertions?: outputs.CheckGroupApiCheckDefaultsAssertion[];
|
|
221
|
-
/**
|
|
222
|
-
* . Possible arguments
|
|
223
|
-
*/
|
|
224
95
|
basicAuth: outputs.CheckGroupApiCheckDefaultsBasicAuth;
|
|
225
|
-
/**
|
|
226
|
-
* .
|
|
227
|
-
*/
|
|
228
96
|
headers: {
|
|
229
97
|
[key: string]: any;
|
|
230
98
|
};
|
|
231
|
-
/**
|
|
232
|
-
* .
|
|
233
|
-
*/
|
|
234
99
|
queryParameters: {
|
|
235
100
|
[key: string]: any;
|
|
236
101
|
};
|
|
237
|
-
/**
|
|
238
|
-
* The base url for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks.
|
|
239
|
-
*/
|
|
240
102
|
url: string;
|
|
241
103
|
}
|
|
242
104
|
/**
|
|
@@ -244,17 +106,8 @@ export interface CheckGroupApiCheckDefaults {
|
|
|
244
106
|
*/
|
|
245
107
|
export declare function checkGroupApiCheckDefaultsProvideDefaults(val: CheckGroupApiCheckDefaults): CheckGroupApiCheckDefaults;
|
|
246
108
|
export interface CheckGroupApiCheckDefaultsAssertion {
|
|
247
|
-
/**
|
|
248
|
-
* Possible values `EQUALS`, `NOT_EQUALS`, `HAS_KEY`, `NOT_HAS_KEY`, `HAS_VALUE`, `NOT_HAS_VALUE`, `IS_EMPTY`, `NOT_EMPTY`, `GREATER_THAN`, `LESS_THAN`, `CONTAINS`, `NOT_CONTAINS`, `IS_NULL`, and `NOT_NULL`.
|
|
249
|
-
*/
|
|
250
109
|
comparison: string;
|
|
251
|
-
/**
|
|
252
|
-
* .
|
|
253
|
-
*/
|
|
254
110
|
property?: string;
|
|
255
|
-
/**
|
|
256
|
-
* Possible values `STATUS_CODE`, `JSON_BODY`, `HEADERS`, `TEXT_BODY`, and `RESPONSE_TIME`.
|
|
257
|
-
*/
|
|
258
111
|
source: string;
|
|
259
112
|
target: string;
|
|
260
113
|
}
|
|
@@ -263,64 +116,25 @@ export interface CheckGroupApiCheckDefaultsBasicAuth {
|
|
|
263
116
|
username: string;
|
|
264
117
|
}
|
|
265
118
|
export interface CheckRequest {
|
|
266
|
-
/**
|
|
267
|
-
* A request can have multiple assetions. Assertion has the following arguments:
|
|
268
|
-
*/
|
|
269
119
|
assertions?: outputs.CheckRequestAssertion[];
|
|
270
|
-
/**
|
|
271
|
-
* A request might have one basicAuth config. basicAuth has two arguments:
|
|
272
|
-
*/
|
|
273
120
|
basicAuth: outputs.CheckRequestBasicAuth;
|
|
274
121
|
body?: string;
|
|
275
|
-
/**
|
|
276
|
-
* Possible values `NONE`, `JSON`, `FORM`, `RAW`, and `GRAPHQL`.
|
|
277
|
-
*/
|
|
278
122
|
bodyType?: string;
|
|
279
|
-
/**
|
|
280
|
-
* .
|
|
281
|
-
*/
|
|
282
123
|
followRedirects?: boolean;
|
|
283
|
-
/**
|
|
284
|
-
* .
|
|
285
|
-
*/
|
|
286
124
|
headers: {
|
|
287
125
|
[key: string]: any;
|
|
288
126
|
};
|
|
289
|
-
/**
|
|
290
|
-
* The HTTP method to use for this API check. Possible values are `GET`, `POST`, `PUT`, `HEAD`, `DELETE`, `PATCH`. Defaults to `GET`.
|
|
291
|
-
*/
|
|
292
127
|
method?: string;
|
|
293
|
-
/**
|
|
294
|
-
* .
|
|
295
|
-
*/
|
|
296
128
|
queryParameters: {
|
|
297
129
|
[key: string]: any;
|
|
298
130
|
};
|
|
299
|
-
/**
|
|
300
|
-
* .
|
|
301
|
-
*/
|
|
302
131
|
skipSsl?: boolean;
|
|
303
|
-
/**
|
|
304
|
-
* .
|
|
305
|
-
*/
|
|
306
132
|
url: string;
|
|
307
133
|
}
|
|
308
134
|
export interface CheckRequestAssertion {
|
|
309
|
-
/**
|
|
310
|
-
* Possible values `EQUALS`, `NOT_EQUALS`, `HAS_KEY`, `NOT_HAS_KEY`, `HAS_VALUE`, `NOT_HAS_VALUE`, `IS_EMPTY`, `NOT_EMPTY`, `GREATER_THAN`, `LESS_THAN`, `CONTAINS`, `NOT_CONTAINS`, `IS_NULL`, and `NOT_NULL`.
|
|
311
|
-
*/
|
|
312
135
|
comparison: string;
|
|
313
|
-
/**
|
|
314
|
-
* .
|
|
315
|
-
*/
|
|
316
136
|
property?: string;
|
|
317
|
-
/**
|
|
318
|
-
* Possible values `STATUS_CODE`, `JSON_BODY`, `HEADERS`, `TEXT_BODY`, and `RESPONSE_TIME`.
|
|
319
|
-
*/
|
|
320
137
|
source: string;
|
|
321
|
-
/**
|
|
322
|
-
* .
|
|
323
|
-
*/
|
|
324
138
|
target?: string;
|
|
325
139
|
}
|
|
326
140
|
export interface CheckRequestBasicAuth {
|
package/bin/types/output.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"output.js","sourceRoot":"","sources":["../../types/output.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;
|
|
1
|
+
{"version":3,"file":"output.js","sourceRoot":"","sources":["../../types/output.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAuHjF;;GAEG;AACH,SAAgB,yCAAyC,CAAC,GAA+B;;IACrF,uCACO,GAAG,KACN,GAAG,EAAE,MAAA,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,EAAE,IACtB;AACN,CAAC;AALD,8FAKC"}
|