Reference
1 min read

Vercel REST API Interfaces

Shared interfaces referenced across multiple endpoints.
Table of Contents

ACLAction

1
{
2
"type": "string",
3
"enum": ["create", "delete", "read", "update", "list"],
4
"description": "Enum containing the actions that can be performed against a resource. Group operations are included."
5
}

AuthToken

1
{
2
"properties": {
3
"id": {
4
"type": "string",
5
"description": "The unique identifier of the token.",
6
"example": "5d9f2ebd38ddca62e5d51e9c1704c72530bdc8bfdd41e782a6687c48399e8391"
7
},
8
"name": {
9
"type": "string",
10
"description": "The human-readable name of the token."
11
},
12
"type": {
13
"type": "string",
14
"description": "The type of the token.",
15
"example": "oauth2-token"
16
},
17
"origin": {
18
"type": "string",
19
"description": "The origin of how the token was created.",
20
"example": "github"
21
},
22
"scopes": {
23
"items": {
24
"oneOf": [
25
{
26
"properties": {
27
"type": { "type": "string", "enum": ["user"] },
28
"origin": {
29
"type": "string",
30
"enum": [
31
"saml",
32
"github",
33
"gitlab",
34
"bitbucket",
35
"email",
36
"manual",
37
"passkey"
38
]
39
},
40
"createdAt": { "type": "number" },
41
"expiresAt": { "type": "number" }
42
},
43
"required": ["type", "origin", "createdAt"],
44
"type": "object",
45
"description": "The access scopes granted to the token."
46
},
47
{
48
"properties": {
49
"type": { "type": "string", "enum": ["team"] },
50
"teamId": { "type": "string" },
51
"origin": {
52
"type": "string",
53
"enum": [
54
"saml",
55
"github",
56
"gitlab",
57
"bitbucket",
58
"email",
59
"manual",
60
"passkey"
61
]
62
},
63
"createdAt": { "type": "number" },
64
"expiresAt": { "type": "number" }
65
},
66
"required": ["type", "teamId", "origin", "createdAt"],
67
"type": "object",
68
"description": "The access scopes granted to the token."
69
}
70
]
71
},
72
"type": "array",
73
"description": "The access scopes granted to the token."
74
},
75
"expiresAt": {
76
"type": "number",
77
"description": "Timestamp (in milliseconds) of when the token expires.",
78
"example": 1632816536002
79
},
80
"activeAt": {
81
"type": "number",
82
"description": "Timestamp (in milliseconds) of when the token was most recently used.",
83
"example": 1632816536002
84
},
85
"createdAt": {
86
"type": "number",
87
"description": "Timestamp (in milliseconds) of when the token was created.",
88
"example": 1632816536002
89
}
90
},
91
"required": ["id", "name", "type", "activeAt", "createdAt"],
92
"type": "object",
93
"description": "Authentication token metadata."
94
}

AuthUser

1
{
2
"properties": {
3
"createdAt": {
4
"type": "number",
5
"description": "UNIX timestamp (in milliseconds) when the User account was created.",
6
"example": 1630748523395
7
},
8
"softBlock": {
9
"nullable": true,
10
"properties": {
11
"blockedAt": { "type": "number" },
12
"reason": {
13
"type": "string",
14
"enum": [
15
"SUBSCRIPTION_CANCELED",
16
"SUBSCRIPTION_EXPIRED",
17
"UNPAID_INVOICE",
18
"ENTERPRISE_TRIAL_ENDED",
19
"FAIR_USE_LIMITS_EXCEEDED",
20
"BLOCKED_FOR_PLATFORM_ABUSE"
21
]
22
},
23
"blockedDueToOverageType": {
24
"type": "string",
25
"enum": [
26
"analyticsUsage",
27
"artifacts",
28
"bandwidth",
29
"blobStores",
30
"blobTotalAdvancedRequests",
31
"blobTotalAvgSizeInBytes",
32
"blobTotalGetResponseObjectSizeInBytes",
33
"blobTotalSimpleRequests",
34
"buildMinute",
35
"dataCacheRead",
36
"dataCacheRevalidation",
37
"dataCacheWrite",
38
"edgeConfigRead",
39
"edgeConfigWrite",
40
"edgeFunctionExecutionUnits",
41
"edgeMiddlewareInvocations",
42
"edgeRequest",
43
"edgeRequestAdditionalCpuDuration",
44
"fastDataTransfer",
45
"fastOriginTransfer",
46
"functionDuration",
47
"functionInvocation",
48
"logDrainsVolume",
49
"monitoringMetric",
50
"postgresComputeTime",
51
"postgresDataStorage",
52
"postgresDataTransfer",
53
"postgresDatabase",
54
"postgresWrittenData",
55
"serverlessFunctionExecution",
56
"sourceImages",
57
"storageRedisTotalBandwidthInBytes",
58
"storageRedisTotalCommands",
59
"storageRedisTotalDailyAvgStorageInBytes",
60
"storageRedisTotalDatabases",
61
"wafOwaspExcessBytes",
62
"wafOwaspRequests",
63
"webAnalyticsEvent"
64
]
65
}
66
},
67
"required": ["blockedAt", "reason"],
68
"type": "object",
69
"description": "When the User account has been \"soft blocked\", this property will contain the date when the restriction was enacted, and the identifier for why."
70
},
71
"billing": {
72
"nullable": true,
73
"properties": {
74
"currency": { "type": "string", "enum": ["usd", "eur"] },
75
"cancelation": { "nullable": true, "type": "number" },
76
"period": {
77
"nullable": true,
78
"properties": {
79
"start": { "type": "number" },
80
"end": { "type": "number" }
81
},
82
"required": ["start", "end"],
83
"type": "object"
84
},
85
"contract": {
86
"nullable": true,
87
"properties": {
88
"start": { "type": "number" },
89
"end": { "type": "number" }
90
},
91
"required": ["start", "end"],
92
"type": "object"
93
},
94
"plan": { "type": "string", "enum": ["pro", "enterprise", "hobby"] },
95
"planIteration": { "type": "string" },
96
"platform": { "type": "string", "enum": ["stripe", "stripeTestMode"] },
97
"orbCustomerId": { "type": "string" },
98
"syncedAt": { "type": "number" },
99
"programType": { "type": "string", "enum": ["startup", "agency"] },
100
"trial": {
101
"nullable": true,
102
"properties": {
103
"start": { "type": "number" },
104
"end": { "type": "number" }
105
},
106
"required": ["start", "end"],
107
"type": "object"
108
},
109
"email": { "nullable": true, "type": "string" },
110
"tax": {
111
"nullable": true,
112
"properties": {
113
"type": { "type": "string" },
114
"id": { "type": "string" }
115
},
116
"required": ["type", "id"],
117
"type": "object"
118
},
119
"language": { "nullable": true, "type": "string" },
120
"address": {
121
"nullable": true,
122
"properties": {
123
"line1": { "type": "string" },
124
"line2": { "type": "string" },
125
"postalCode": { "type": "string" },
126
"city": { "type": "string" },
127
"country": { "type": "string" },
128
"state": { "type": "string" }
129
},
130
"type": "object"
131
},
132
"name": { "nullable": true, "type": "string" },
133
"invoiceItems": {
134
"nullable": true,
135
"properties": {
136
"concurrentBuilds": {
137
"properties": {
138
"tier": { "type": "number" },
139
"price": { "type": "number" },
140
"quantity": { "type": "number" },
141
"highestQuantity": { "type": "number" },
142
"name": { "type": "string" },
143
"hidden": { "type": "boolean" },
144
"createdAt": { "type": "number" },
145
"disabledAt": { "nullable": true, "type": "number" },
146
"frequency": {
147
"properties": {
148
"interval": { "type": "string", "enum": ["month"] },
149
"intervalCount": {
150
"type": "number",
151
"enum": [1, 2, 3, 6, 12]
152
}
153
},
154
"required": ["interval", "intervalCount"],
155
"type": "object"
156
},
157
"maxQuantity": { "type": "number" }
158
},
159
"required": ["price", "quantity", "hidden"],
160
"type": "object",
161
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
162
},
163
"webAnalytics": {
164
"properties": {
165
"tier": { "type": "number" },
166
"price": { "type": "number" },
167
"quantity": { "type": "number" },
168
"highestQuantity": { "type": "number" },
169
"name": { "type": "string" },
170
"hidden": { "type": "boolean" },
171
"createdAt": { "type": "number" },
172
"disabledAt": { "nullable": true, "type": "number" },
173
"frequency": {
174
"properties": {
175
"interval": { "type": "string", "enum": ["month"] },
176
"intervalCount": {
177
"type": "number",
178
"enum": [1, 2, 3, 6, 12]
179
}
180
},
181
"required": ["interval", "intervalCount"],
182
"type": "object"
183
},
184
"maxQuantity": { "type": "number" }
185
},
186
"required": ["price", "quantity", "hidden"],
187
"type": "object",
188
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
189
},
190
"pro": {
191
"properties": {
192
"tier": { "type": "number" },
193
"price": { "type": "number" },
194
"quantity": { "type": "number" },
195
"highestQuantity": { "type": "number" },
196
"name": { "type": "string" },
197
"hidden": { "type": "boolean" },
198
"createdAt": { "type": "number" },
199
"disabledAt": { "nullable": true, "type": "number" },
200
"frequency": {
201
"properties": {
202
"interval": { "type": "string", "enum": ["month"] },
203
"intervalCount": {
204
"type": "number",
205
"enum": [1, 2, 3, 6, 12]
206
}
207
},
208
"required": ["interval", "intervalCount"],
209
"type": "object"
210
},
211
"maxQuantity": { "type": "number" }
212
},
213
"required": ["price", "quantity", "hidden"],
214
"type": "object",
215
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
216
},
217
"enterprise": {
218
"properties": {
219
"tier": { "type": "number" },
220
"price": { "type": "number" },
221
"quantity": { "type": "number" },
222
"highestQuantity": { "type": "number" },
223
"name": { "type": "string" },
224
"hidden": { "type": "boolean" },
225
"createdAt": { "type": "number" },
226
"disabledAt": { "nullable": true, "type": "number" },
227
"frequency": {
228
"properties": {
229
"interval": { "type": "string", "enum": ["month"] },
230
"intervalCount": {
231
"type": "number",
232
"enum": [1, 2, 3, 6, 12]
233
}
234
},
235
"required": ["interval", "intervalCount"],
236
"type": "object"
237
},
238
"maxQuantity": { "type": "number" }
239
},
240
"required": ["price", "quantity", "hidden"],
241
"type": "object",
242
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
243
},
244
"analytics": {
245
"properties": {
246
"tier": { "type": "number" },
247
"price": { "type": "number" },
248
"quantity": { "type": "number" },
249
"highestQuantity": { "type": "number" },
250
"name": { "type": "string" },
251
"hidden": { "type": "boolean" },
252
"createdAt": { "type": "number" },
253
"disabledAt": { "nullable": true, "type": "number" },
254
"frequency": {
255
"properties": {
256
"interval": { "type": "string", "enum": ["month"] },
257
"intervalCount": {
258
"type": "number",
259
"enum": [1, 2, 3, 6, 12]
260
}
261
},
262
"required": ["interval", "intervalCount"],
263
"type": "object"
264
},
265
"maxQuantity": { "type": "number" }
266
},
267
"required": ["price", "quantity", "hidden"],
268
"type": "object",
269
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
270
},
271
"monitoring": {
272
"properties": {
273
"tier": { "type": "number" },
274
"price": { "type": "number" },
275
"quantity": { "type": "number" },
276
"highestQuantity": { "type": "number" },
277
"name": { "type": "string" },
278
"hidden": { "type": "boolean" },
279
"createdAt": { "type": "number" },
280
"disabledAt": { "nullable": true, "type": "number" },
281
"frequency": {
282
"properties": {
283
"interval": { "type": "string", "enum": ["month"] },
284
"intervalCount": {
285
"type": "number",
286
"enum": [1, 2, 3, 6, 12]
287
}
288
},
289
"required": ["interval", "intervalCount"],
290
"type": "object"
291
},
292
"maxQuantity": { "type": "number" }
293
},
294
"required": ["price", "quantity", "hidden"],
295
"type": "object",
296
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
297
},
298
"passwordProtection": {
299
"properties": {
300
"tier": { "type": "number" },
301
"price": { "type": "number" },
302
"quantity": { "type": "number" },
303
"highestQuantity": { "type": "number" },
304
"name": { "type": "string" },
305
"hidden": { "type": "boolean" },
306
"createdAt": { "type": "number" },
307
"disabledAt": { "nullable": true, "type": "number" },
308
"frequency": {
309
"properties": {
310
"interval": { "type": "string", "enum": ["month"] },
311
"intervalCount": {
312
"type": "number",
313
"enum": [1, 2, 3, 6, 12]
314
}
315
},
316
"required": ["interval", "intervalCount"],
317
"type": "object"
318
},
319
"maxQuantity": { "type": "number" }
320
},
321
"required": ["price", "quantity", "hidden"],
322
"type": "object",
323
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
324
},
325
"previewDeploymentSuffix": {
326
"properties": {
327
"tier": { "type": "number" },
328
"price": { "type": "number" },
329
"quantity": { "type": "number" },
330
"highestQuantity": { "type": "number" },
331
"name": { "type": "string" },
332
"hidden": { "type": "boolean" },
333
"createdAt": { "type": "number" },
334
"disabledAt": { "nullable": true, "type": "number" },
335
"frequency": {
336
"properties": {
337
"interval": { "type": "string", "enum": ["month"] },
338
"intervalCount": {
339
"type": "number",
340
"enum": [1, 2, 3, 6, 12]
341
}
342
},
343
"required": ["interval", "intervalCount"],
344
"type": "object"
345
},
346
"maxQuantity": { "type": "number" }
347
},
348
"required": ["price", "quantity", "hidden"],
349
"type": "object",
350
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
351
},
352
"saml": {
353
"properties": {
354
"tier": { "type": "number" },
355
"price": { "type": "number" },
356
"quantity": { "type": "number" },
357
"highestQuantity": { "type": "number" },
358
"name": { "type": "string" },
359
"hidden": { "type": "boolean" },
360
"createdAt": { "type": "number" },
361
"disabledAt": { "nullable": true, "type": "number" },
362
"frequency": {
363
"properties": {
364
"interval": { "type": "string", "enum": ["month"] },
365
"intervalCount": {
366
"type": "number",
367
"enum": [1, 2, 3, 6, 12]
368
}
369
},
370
"required": ["interval", "intervalCount"],
371
"type": "object"
372
},
373
"maxQuantity": { "type": "number" }
374
},
375
"required": ["price", "quantity", "hidden"],
376
"type": "object",
377
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
378
},
379
"teamSeats": {
380
"properties": {
381
"tier": { "type": "number" },
382
"price": { "type": "number" },
383
"quantity": { "type": "number" },
384
"highestQuantity": { "type": "number" },
385
"name": { "type": "string" },
386
"hidden": { "type": "boolean" },
387
"createdAt": { "type": "number" },
388
"disabledAt": { "nullable": true, "type": "number" },
389
"frequency": {
390
"properties": {
391
"interval": { "type": "string", "enum": ["month"] },
392
"intervalCount": {
393
"type": "number",
394
"enum": [1, 2, 3, 6, 12]
395
}
396
},
397
"required": ["interval", "intervalCount"],
398
"type": "object"
399
},
400
"maxQuantity": { "type": "number" }
401
},
402
"required": ["price", "quantity", "hidden"],
403
"type": "object",
404
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
405
},
406
"analyticsUsage": {
407
"properties": {
408
"matrix": {
409
"properties": {
410
"defaultUnitPrice": { "type": "string" },
411
"dimensionPrices": {
412
"additionalProperties": { "type": "string" },
413
"type": "object"
414
}
415
},
416
"required": ["defaultUnitPrice", "dimensionPrices"],
417
"type": "object"
418
},
419
"tier": { "type": "number" },
420
"price": { "type": "number" },
421
"batch": { "type": "number" },
422
"threshold": { "type": "number" },
423
"name": { "type": "string" },
424
"hidden": { "type": "boolean" },
425
"disabledAt": { "nullable": true, "type": "number" },
426
"enabledAt": { "nullable": true, "type": "number" }
427
},
428
"required": ["price", "batch", "threshold", "hidden"],
429
"type": "object"
430
},
431
"artifacts": {
432
"properties": {
433
"matrix": {
434
"properties": {
435
"defaultUnitPrice": { "type": "string" },
436
"dimensionPrices": {
437
"additionalProperties": { "type": "string" },
438
"type": "object"
439
}
440
},
441
"required": ["defaultUnitPrice", "dimensionPrices"],
442
"type": "object"
443
},
444
"tier": { "type": "number" },
445
"price": { "type": "number" },
446
"batch": { "type": "number" },
447
"threshold": { "type": "number" },
448
"name": { "type": "string" },
449
"hidden": { "type": "boolean" },
450
"disabledAt": { "nullable": true, "type": "number" },
451
"enabledAt": { "nullable": true, "type": "number" }
452
},
453
"required": ["price", "batch", "threshold", "hidden"],
454
"type": "object"
455
},
456
"bandwidth": {
457
"properties": {
458
"matrix": {
459
"properties": {
460
"defaultUnitPrice": { "type": "string" },
461
"dimensionPrices": {
462
"additionalProperties": { "type": "string" },
463
"type": "object"
464
}
465
},
466
"required": ["defaultUnitPrice", "dimensionPrices"],
467
"type": "object"
468
},
469
"tier": { "type": "number" },
470
"price": { "type": "number" },
471
"batch": { "type": "number" },
472
"threshold": { "type": "number" },
473
"name": { "type": "string" },
474
"hidden": { "type": "boolean" },
475
"disabledAt": { "nullable": true, "type": "number" },
476
"enabledAt": { "nullable": true, "type": "number" }
477
},
478
"required": ["price", "batch", "threshold", "hidden"],
479
"type": "object"
480
},
481
"blobStores": {
482
"properties": {
483
"matrix": {
484
"properties": {
485
"defaultUnitPrice": { "type": "string" },
486
"dimensionPrices": {
487
"additionalProperties": { "type": "string" },
488
"type": "object"
489
}
490
},
491
"required": ["defaultUnitPrice", "dimensionPrices"],
492
"type": "object"
493
},
494
"tier": { "type": "number" },
495
"price": { "type": "number" },
496
"batch": { "type": "number" },
497
"threshold": { "type": "number" },
498
"name": { "type": "string" },
499
"hidden": { "type": "boolean" },
500
"disabledAt": { "nullable": true, "type": "number" },
501
"enabledAt": { "nullable": true, "type": "number" }
502
},
503
"required": ["price", "batch", "threshold", "hidden"],
504
"type": "object"
505
},
506
"blobTotalAdvancedRequests": {
507
"properties": {
508
"matrix": {
509
"properties": {
510
"defaultUnitPrice": { "type": "string" },
511
"dimensionPrices": {
512
"additionalProperties": { "type": "string" },
513
"type": "object"
514
}
515
},
516
"required": ["defaultUnitPrice", "dimensionPrices"],
517
"type": "object"
518
},
519
"tier": { "type": "number" },
520
"price": { "type": "number" },
521
"batch": { "type": "number" },
522
"threshold": { "type": "number" },
523
"name": { "type": "string" },
524
"hidden": { "type": "boolean" },
525
"disabledAt": { "nullable": true, "type": "number" },
526
"enabledAt": { "nullable": true, "type": "number" }
527
},
528
"required": ["price", "batch", "threshold", "hidden"],
529
"type": "object"
530
},
531
"blobTotalAvgSizeInBytes": {
532
"properties": {
533
"matrix": {
534
"properties": {
535
"defaultUnitPrice": { "type": "string" },
536
"dimensionPrices": {
537
"additionalProperties": { "type": "string" },
538
"type": "object"
539
}
540
},
541
"required": ["defaultUnitPrice", "dimensionPrices"],
542
"type": "object"
543
},
544
"tier": { "type": "number" },
545
"price": { "type": "number" },
546
"batch": { "type": "number" },
547
"threshold": { "type": "number" },
548
"name": { "type": "string" },
549
"hidden": { "type": "boolean" },
550
"disabledAt": { "nullable": true, "type": "number" },
551
"enabledAt": { "nullable": true, "type": "number" }
552
},
553
"required": ["price", "batch", "threshold", "hidden"],
554
"type": "object"
555
},
556
"blobTotalGetResponseObjectSizeInBytes": {
557
"properties": {
558
"matrix": {
559
"properties": {
560
"defaultUnitPrice": { "type": "string" },
561
"dimensionPrices": {
562
"additionalProperties": { "type": "string" },
563
"type": "object"
564
}
565
},
566
"required": ["defaultUnitPrice", "dimensionPrices"],
567
"type": "object"
568
},
569
"tier": { "type": "number" },
570
"price": { "type": "number" },
571
"batch": { "type": "number" },
572
"threshold": { "type": "number" },
573
"name": { "type": "string" },
574
"hidden": { "type": "boolean" },
575
"disabledAt": { "nullable": true, "type": "number" },
576
"enabledAt": { "nullable": true, "type": "number" }
577
},
578
"required": ["price", "batch", "threshold", "hidden"],
579
"type": "object"
580
},
581
"blobTotalSimpleRequests": {
582
"properties": {
583
"matrix": {
584
"properties": {
585
"defaultUnitPrice": { "type": "string" },
586
"dimensionPrices": {
587
"additionalProperties": { "type": "string" },
588
"type": "object"
589
}
590
},
591
"required": ["defaultUnitPrice", "dimensionPrices"],
592
"type": "object"
593
},
594
"tier": { "type": "number" },
595
"price": { "type": "number" },
596
"batch": { "type": "number" },
597
"threshold": { "type": "number" },
598
"name": { "type": "string" },
599
"hidden": { "type": "boolean" },
600
"disabledAt": { "nullable": true, "type": "number" },
601
"enabledAt": { "nullable": true, "type": "number" }
602
},
603
"required": ["price", "batch", "threshold", "hidden"],
604
"type": "object"
605
},
606
"buildMinute": {
607
"properties": {
608
"matrix": {
609
"properties": {
610
"defaultUnitPrice": { "type": "string" },
611
"dimensionPrices": {
612
"additionalProperties": { "type": "string" },
613
"type": "object"
614
}
615
},
616
"required": ["defaultUnitPrice", "dimensionPrices"],
617
"type": "object"
618
},
619
"tier": { "type": "number" },
620
"price": { "type": "number" },
621
"batch": { "type": "number" },
622
"threshold": { "type": "number" },
623
"name": { "type": "string" },
624
"hidden": { "type": "boolean" },
625
"disabledAt": { "nullable": true, "type": "number" },
626
"enabledAt": { "nullable": true, "type": "number" }
627
},
628
"required": ["price", "batch", "threshold", "hidden"],
629
"type": "object"
630
},
631
"dataCacheRead": {
632
"properties": {
633
"matrix": {
634
"properties": {
635
"defaultUnitPrice": { "type": "string" },
636
"dimensionPrices": {
637
"additionalProperties": { "type": "string" },
638
"type": "object"
639
}
640
},
641
"required": ["defaultUnitPrice", "dimensionPrices"],
642
"type": "object"
643
},
644
"tier": { "type": "number" },
645
"price": { "type": "number" },
646
"batch": { "type": "number" },
647
"threshold": { "type": "number" },
648
"name": { "type": "string" },
649
"hidden": { "type": "boolean" },
650
"disabledAt": { "nullable": true, "type": "number" },
651
"enabledAt": { "nullable": true, "type": "number" }
652
},
653
"required": ["price", "batch", "threshold", "hidden"],
654
"type": "object"
655
},
656
"dataCacheRevalidation": {
657
"properties": {
658
"matrix": {
659
"properties": {
660
"defaultUnitPrice": { "type": "string" },
661
"dimensionPrices": {
662
"additionalProperties": { "type": "string" },
663
"type": "object"
664
}
665
},
666
"required": ["defaultUnitPrice", "dimensionPrices"],
667
"type": "object"
668
},
669
"tier": { "type": "number" },
670
"price": { "type": "number" },
671
"batch": { "type": "number" },
672
"threshold": { "type": "number" },
673
"name": { "type": "string" },
674
"hidden": { "type": "boolean" },
675
"disabledAt": { "nullable": true, "type": "number" },
676
"enabledAt": { "nullable": true, "type": "number" }
677
},
678
"required": ["price", "batch", "threshold", "hidden"],
679
"type": "object"
680
},
681
"dataCacheWrite": {
682
"properties": {
683
"matrix": {
684
"properties": {
685
"defaultUnitPrice": { "type": "string" },
686
"dimensionPrices": {
687
"additionalProperties": { "type": "string" },
688
"type": "object"
689
}
690
},
691
"required": ["defaultUnitPrice", "dimensionPrices"],
692
"type": "object"
693
},
694
"tier": { "type": "number" },
695
"price": { "type": "number" },
696
"batch": { "type": "number" },
697
"threshold": { "type": "number" },
698
"name": { "type": "string" },
699
"hidden": { "type": "boolean" },
700
"disabledAt": { "nullable": true, "type": "number" },
701
"enabledAt": { "nullable": true, "type": "number" }
702
},
703
"required": ["price", "batch", "threshold", "hidden"],
704
"type": "object"
705
},
706
"edgeConfigRead": {
707
"properties": {
708
"matrix": {
709
"properties": {
710
"defaultUnitPrice": { "type": "string" },
711
"dimensionPrices": {
712
"additionalProperties": { "type": "string" },
713
"type": "object"
714
}
715
},
716
"required": ["defaultUnitPrice", "dimensionPrices"],
717
"type": "object"
718
},
719
"tier": { "type": "number" },
720
"price": { "type": "number" },
721
"batch": { "type": "number" },
722
"threshold": { "type": "number" },
723
"name": { "type": "string" },
724
"hidden": { "type": "boolean" },
725
"disabledAt": { "nullable": true, "type": "number" },
726
"enabledAt": { "nullable": true, "type": "number" }
727
},
728
"required": ["price", "batch", "threshold", "hidden"],
729
"type": "object"
730
},
731
"edgeConfigWrite": {
732
"properties": {
733
"matrix": {
734
"properties": {
735
"defaultUnitPrice": { "type": "string" },
736
"dimensionPrices": {
737
"additionalProperties": { "type": "string" },
738
"type": "object"
739
}
740
},
741
"required": ["defaultUnitPrice", "dimensionPrices"],
742
"type": "object"
743
},
744
"tier": { "type": "number" },
745
"price": { "type": "number" },
746
"batch": { "type": "number" },
747
"threshold": { "type": "number" },
748
"name": { "type": "string" },
749
"hidden": { "type": "boolean" },
750
"disabledAt": { "nullable": true, "type": "number" },
751
"enabledAt": { "nullable": true, "type": "number" }
752
},
753
"required": ["price", "batch", "threshold", "hidden"],
754
"type": "object"
755
},
756
"edgeFunctionExecutionUnits": {
757
"properties": {
758
"matrix": {
759
"properties": {
760
"defaultUnitPrice": { "type": "string" },
761
"dimensionPrices": {
762
"additionalProperties": { "type": "string" },
763
"type": "object"
764
}
765
},
766
"required": ["defaultUnitPrice", "dimensionPrices"],
767
"type": "object"
768
},
769
"tier": { "type": "number" },
770
"price": { "type": "number" },
771
"batch": { "type": "number" },
772
"threshold": { "type": "number" },
773
"name": { "type": "string" },
774
"hidden": { "type": "boolean" },
775
"disabledAt": { "nullable": true, "type": "number" },
776
"enabledAt": { "nullable": true, "type": "number" }
777
},
778
"required": ["price", "batch", "threshold", "hidden"],
779
"type": "object"
780
},
781
"edgeMiddlewareInvocations": {
782
"properties": {
783
"matrix": {
784
"properties": {
785
"defaultUnitPrice": { "type": "string" },
786
"dimensionPrices": {
787
"additionalProperties": { "type": "string" },
788
"type": "object"
789
}
790
},
791
"required": ["defaultUnitPrice", "dimensionPrices"],
792
"type": "object"
793
},
794
"tier": { "type": "number" },
795
"price": { "type": "number" },
796
"batch": { "type": "number" },
797
"threshold": { "type": "number" },
798
"name": { "type": "string" },
799
"hidden": { "type": "boolean" },
800
"disabledAt": { "nullable": true, "type": "number" },
801
"enabledAt": { "nullable": true, "type": "number" }
802
},
803
"required": ["price", "batch", "threshold", "hidden"],
804
"type": "object"
805
},
806
"edgeRequest": {
807
"properties": {
808
"matrix": {
809
"properties": {
810
"defaultUnitPrice": { "type": "string" },
811
"dimensionPrices": {
812
"additionalProperties": { "type": "string" },
813
"type": "object"
814
}
815
},
816
"required": ["defaultUnitPrice", "dimensionPrices"],
817
"type": "object"
818
},
819
"tier": { "type": "number" },
820
"price": { "type": "number" },
821
"batch": { "type": "number" },
822
"threshold": { "type": "number" },
823
"name": { "type": "string" },
824
"hidden": { "type": "boolean" },
825
"disabledAt": { "nullable": true, "type": "number" },
826
"enabledAt": { "nullable": true, "type": "number" }
827
},
828
"required": ["price", "batch", "threshold", "hidden"],
829
"type": "object"
830
},
831
"edgeRequestAdditionalCpuDuration": {
832
"properties": {
833
"matrix": {
834
"properties": {
835
"defaultUnitPrice": { "type": "string" },
836
"dimensionPrices": {
837
"additionalProperties": { "type": "string" },
838
"type": "object"
839
}
840
},
841
"required": ["defaultUnitPrice", "dimensionPrices"],
842
"type": "object"
843
},
844
"tier": { "type": "number" },
845
"price": { "type": "number" },
846
"batch": { "type": "number" },
847
"threshold": { "type": "number" },
848
"name": { "type": "string" },
849
"hidden": { "type": "boolean" },
850
"disabledAt": { "nullable": true, "type": "number" },
851
"enabledAt": { "nullable": true, "type": "number" }
852
},
853
"required": ["price", "batch", "threshold", "hidden"],
854
"type": "object"
855
},
856
"fastDataTransfer": {
857
"properties": {
858
"matrix": {
859
"properties": {
860
"defaultUnitPrice": { "type": "string" },
861
"dimensionPrices": {
862
"additionalProperties": { "type": "string" },
863
"type": "object"
864
}
865
},
866
"required": ["defaultUnitPrice", "dimensionPrices"],
867
"type": "object"
868
},
869
"tier": { "type": "number" },
870
"price": { "type": "number" },
871
"batch": { "type": "number" },
872
"threshold": { "type": "number" },
873
"name": { "type": "string" },
874
"hidden": { "type": "boolean" },
875
"disabledAt": { "nullable": true, "type": "number" },
876
"enabledAt": { "nullable": true, "type": "number" }
877
},
878
"required": ["price", "batch", "threshold", "hidden"],
879
"type": "object"
880
},
881
"fastOriginTransfer": {
882
"properties": {
883
"matrix": {
884
"properties": {
885
"defaultUnitPrice": { "type": "string" },
886
"dimensionPrices": {
887
"additionalProperties": { "type": "string" },
888
"type": "object"
889
}
890
},
891
"required": ["defaultUnitPrice", "dimensionPrices"],
892
"type": "object"
893
},
894
"tier": { "type": "number" },
895
"price": { "type": "number" },
896
"batch": { "type": "number" },
897
"threshold": { "type": "number" },
898
"name": { "type": "string" },
899
"hidden": { "type": "boolean" },
900
"disabledAt": { "nullable": true, "type": "number" },
901
"enabledAt": { "nullable": true, "type": "number" }
902
},
903
"required": ["price", "batch", "threshold", "hidden"],
904
"type": "object"
905
},
906
"functionDuration": {
907
"properties": {
908
"matrix": {
909
"properties": {
910
"defaultUnitPrice": { "type": "string" },
911
"dimensionPrices": {
912
"additionalProperties": { "type": "string" },
913
"type": "object"
914
}
915
},
916
"required": ["defaultUnitPrice", "dimensionPrices"],
917
"type": "object"
918
},
919
"tier": { "type": "number" },
920
"price": { "type": "number" },
921
"batch": { "type": "number" },
922
"threshold": { "type": "number" },
923
"name": { "type": "string" },
924
"hidden": { "type": "boolean" },
925
"disabledAt": { "nullable": true, "type": "number" },
926
"enabledAt": { "nullable": true, "type": "number" }
927
},
928
"required": ["price", "batch", "threshold", "hidden"],
929
"type": "object"
930
},
931
"functionInvocation": {
932
"properties": {
933
"matrix": {
934
"properties": {
935
"defaultUnitPrice": { "type": "string" },
936
"dimensionPrices": {
937
"additionalProperties": { "type": "string" },
938
"type": "object"
939
}
940
},
941
"required": ["defaultUnitPrice", "dimensionPrices"],
942
"type": "object"
943
},
944
"tier": { "type": "number" },
945
"price": { "type": "number" },
946
"batch": { "type": "number" },
947
"threshold": { "type": "number" },
948
"name": { "type": "string" },
949
"hidden": { "type": "boolean" },
950
"disabledAt": { "nullable": true, "type": "number" },
951
"enabledAt": { "nullable": true, "type": "number" }
952
},
953
"required": ["price", "batch", "threshold", "hidden"],
954
"type": "object"
955
},
956
"logDrainsVolume": {
957
"properties": {
958
"matrix": {
959
"properties": {
960
"defaultUnitPrice": { "type": "string" },
961
"dimensionPrices": {
962
"additionalProperties": { "type": "string" },
963
"type": "object"
964
}
965
},
966
"required": ["defaultUnitPrice", "dimensionPrices"],
967
"type": "object"
968
},
969
"tier": { "type": "number" },
970
"price": { "type": "number" },
971
"batch": { "type": "number" },
972
"threshold": { "type": "number" },
973
"name": { "type": "string" },
974
"hidden": { "type": "boolean" },
975
"disabledAt": { "nullable": true, "type": "number" },
976
"enabledAt": { "nullable": true, "type": "number" }
977
},
978
"required": ["price", "batch", "threshold", "hidden"],
979
"type": "object"
980
},
981
"monitoringMetric": {
982
"properties": {
983
"matrix": {
984
"properties": {
985
"defaultUnitPrice": { "type": "string" },
986
"dimensionPrices": {
987
"additionalProperties": { "type": "string" },
988
"type": "object"
989
}
990
},
991
"required": ["defaultUnitPrice", "dimensionPrices"],
992
"type": "object"
993
},
994
"tier": { "type": "number" },
995
"price": { "type": "number" },
996
"batch": { "type": "number" },
997
"threshold": { "type": "number" },
998
"name": { "type": "string" },
999
"hidden": { "type": "boolean" },
1000
"disabledAt": { "nullable": true, "type": "number" },
1001
"enabledAt": { "nullable": true, "type": "number" }
1002
},
1003
"required": ["price", "batch", "threshold", "hidden"],
1004
"type": "object"
1005
},
1006
"postgresComputeTime": {
1007
"properties": {
1008
"matrix": {
1009
"properties": {
1010
"defaultUnitPrice": { "type": "string" },
1011
"dimensionPrices": {
1012
"additionalProperties": { "type": "string" },
1013
"type": "object"
1014
}
1015
},
1016
"required": ["defaultUnitPrice", "dimensionPrices"],
1017
"type": "object"
1018
},
1019
"tier": { "type": "number" },
1020
"price": { "type": "number" },
1021
"batch": { "type": "number" },
1022
"threshold": { "type": "number" },
1023
"name": { "type": "string" },
1024
"hidden": { "type": "boolean" },
1025
"disabledAt": { "nullable": true, "type": "number" },
1026
"enabledAt": { "nullable": true, "type": "number" }
1027
},
1028
"required": ["price", "batch", "threshold", "hidden"],
1029
"type": "object"
1030
},
1031
"postgresDataStorage": {
1032
"properties": {
1033
"matrix": {
1034
"properties": {
1035
"defaultUnitPrice": { "type": "string" },
1036
"dimensionPrices": {
1037
"additionalProperties": { "type": "string" },
1038
"type": "object"
1039
}
1040
},
1041
"required": ["defaultUnitPrice", "dimensionPrices"],
1042
"type": "object"
1043
},
1044
"tier": { "type": "number" },
1045
"price": { "type": "number" },
1046
"batch": { "type": "number" },
1047
"threshold": { "type": "number" },
1048
"name": { "type": "string" },
1049
"hidden": { "type": "boolean" },
1050
"disabledAt": { "nullable": true, "type": "number" },
1051
"enabledAt": { "nullable": true, "type": "number" }
1052
},
1053
"required": ["price", "batch", "threshold", "hidden"],
1054
"type": "object"
1055
},
1056
"postgresDataTransfer": {
1057
"properties": {
1058
"matrix": {
1059
"properties": {
1060
"defaultUnitPrice": { "type": "string" },
1061
"dimensionPrices": {
1062
"additionalProperties": { "type": "string" },
1063
"type": "object"
1064
}
1065
},
1066
"required": ["defaultUnitPrice", "dimensionPrices"],
1067
"type": "object"
1068
},
1069
"tier": { "type": "number" },
1070
"price": { "type": "number" },
1071
"batch": { "type": "number" },
1072
"threshold": { "type": "number" },
1073
"name": { "type": "string" },
1074
"hidden": { "type": "boolean" },
1075
"disabledAt": { "nullable": true, "type": "number" },
1076
"enabledAt": { "nullable": true, "type": "number" }
1077
},
1078
"required": ["price", "batch", "threshold", "hidden"],
1079
"type": "object"
1080
},
1081
"postgresDatabase": {
1082
"properties": {
1083
"matrix": {
1084
"properties": {
1085
"defaultUnitPrice": { "type": "string" },
1086
"dimensionPrices": {
1087
"additionalProperties": { "type": "string" },
1088
"type": "object"
1089
}
1090
},
1091
"required": ["defaultUnitPrice", "dimensionPrices"],
1092
"type": "object"
1093
},
1094
"tier": { "type": "number" },
1095
"price": { "type": "number" },
1096
"batch": { "type": "number" },
1097
"threshold": { "type": "number" },
1098
"name": { "type": "string" },
1099
"hidden": { "type": "boolean" },
1100
"disabledAt": { "nullable": true, "type": "number" },
1101
"enabledAt": { "nullable": true, "type": "number" }
1102
},
1103
"required": ["price", "batch", "threshold", "hidden"],
1104
"type": "object"
1105
},
1106
"postgresWrittenData": {
1107
"properties": {
1108
"matrix": {
1109
"properties": {
1110
"defaultUnitPrice": { "type": "string" },
1111
"dimensionPrices": {
1112
"additionalProperties": { "type": "string" },
1113
"type": "object"
1114
}
1115
},
1116
"required": ["defaultUnitPrice", "dimensionPrices"],
1117
"type": "object"
1118
},
1119
"tier": { "type": "number" },
1120
"price": { "type": "number" },
1121
"batch": { "type": "number" },
1122
"threshold": { "type": "number" },
1123
"name": { "type": "string" },
1124
"hidden": { "type": "boolean" },
1125
"disabledAt": { "nullable": true, "type": "number" },
1126
"enabledAt": { "nullable": true, "type": "number" }
1127
},
1128
"required": ["price", "batch", "threshold", "hidden"],
1129
"type": "object"
1130
},
1131
"serverlessFunctionExecution": {
1132
"properties": {
1133
"matrix": {
1134
"properties": {
1135
"defaultUnitPrice": { "type": "string" },
1136
"dimensionPrices": {
1137
"additionalProperties": { "type": "string" },
1138
"type": "object"
1139
}
1140
},
1141
"required": ["defaultUnitPrice", "dimensionPrices"],
1142
"type": "object"
1143
},
1144
"tier": { "type": "number" },
1145
"price": { "type": "number" },
1146
"batch": { "type": "number" },
1147
"threshold": { "type": "number" },
1148
"name": { "type": "string" },
1149
"hidden": { "type": "boolean" },
1150
"disabledAt": { "nullable": true, "type": "number" },
1151
"enabledAt": { "nullable": true, "type": "number" }
1152
},
1153
"required": ["price", "batch", "threshold", "hidden"],
1154
"type": "object"
1155
},
1156
"sourceImages": {
1157
"properties": {
1158
"matrix": {
1159
"properties": {
1160
"defaultUnitPrice": { "type": "string" },
1161
"dimensionPrices": {
1162
"additionalProperties": { "type": "string" },
1163
"type": "object"
1164
}
1165
},
1166
"required": ["defaultUnitPrice", "dimensionPrices"],
1167
"type": "object"
1168
},
1169
"tier": { "type": "number" },
1170
"price": { "type": "number" },
1171
"batch": { "type": "number" },
1172
"threshold": { "type": "number" },
1173
"name": { "type": "string" },
1174
"hidden": { "type": "boolean" },
1175
"disabledAt": { "nullable": true, "type": "number" },
1176
"enabledAt": { "nullable": true, "type": "number" }
1177
},
1178
"required": ["price", "batch", "threshold", "hidden"],
1179
"type": "object"
1180
},
1181
"storageRedisTotalBandwidthInBytes": {
1182
"properties": {
1183
"matrix": {
1184
"properties": {
1185
"defaultUnitPrice": { "type": "string" },
1186
"dimensionPrices": {
1187
"additionalProperties": { "type": "string" },
1188
"type": "object"
1189
}
1190
},
1191
"required": ["defaultUnitPrice", "dimensionPrices"],
1192
"type": "object"
1193
},
1194
"tier": { "type": "number" },
1195
"price": { "type": "number" },
1196
"batch": { "type": "number" },
1197
"threshold": { "type": "number" },
1198
"name": { "type": "string" },
1199
"hidden": { "type": "boolean" },
1200
"disabledAt": { "nullable": true, "type": "number" },
1201
"enabledAt": { "nullable": true, "type": "number" }
1202
},
1203
"required": ["price", "batch", "threshold", "hidden"],
1204
"type": "object"
1205
},
1206
"storageRedisTotalCommands": {
1207
"properties": {
1208
"matrix": {
1209
"properties": {
1210
"defaultUnitPrice": { "type": "string" },
1211
"dimensionPrices": {
1212
"additionalProperties": { "type": "string" },
1213
"type": "object"
1214
}
1215
},
1216
"required": ["defaultUnitPrice", "dimensionPrices"],
1217
"type": "object"
1218
},
1219
"tier": { "type": "number" },
1220
"price": { "type": "number" },
1221
"batch": { "type": "number" },
1222
"threshold": { "type": "number" },
1223
"name": { "type": "string" },
1224
"hidden": { "type": "boolean" },
1225
"disabledAt": { "nullable": true, "type": "number" },
1226
"enabledAt": { "nullable": true, "type": "number" }
1227
},
1228
"required": ["price", "batch", "threshold", "hidden"],
1229
"type": "object"
1230
},
1231
"storageRedisTotalDailyAvgStorageInBytes": {
1232
"properties": {
1233
"matrix": {
1234
"properties": {
1235
"defaultUnitPrice": { "type": "string" },
1236
"dimensionPrices": {
1237
"additionalProperties": { "type": "string" },
1238
"type": "object"
1239
}
1240
},
1241
"required": ["defaultUnitPrice", "dimensionPrices"],
1242
"type": "object"
1243
},
1244
"tier": { "type": "number" },
1245
"price": { "type": "number" },
1246
"batch": { "type": "number" },
1247
"threshold": { "type": "number" },
1248
"name": { "type": "string" },
1249
"hidden": { "type": "boolean" },
1250
"disabledAt": { "nullable": true, "type": "number" },
1251
"enabledAt": { "nullable": true, "type": "number" }
1252
},
1253
"required": ["price", "batch", "threshold", "hidden"],
1254
"type": "object"
1255
},
1256
"storageRedisTotalDatabases": {
1257
"properties": {
1258
"matrix": {
1259
"properties": {
1260
"defaultUnitPrice": { "type": "string" },
1261
"dimensionPrices": {
1262
"additionalProperties": { "type": "string" },
1263
"type": "object"
1264
}
1265
},
1266
"required": ["defaultUnitPrice", "dimensionPrices"],
1267
"type": "object"
1268
},
1269
"tier": { "type": "number" },
1270
"price": { "type": "number" },
1271
"batch": { "type": "number" },
1272
"threshold": { "type": "number" },
1273
"name": { "type": "string" },
1274
"hidden": { "type": "boolean" },
1275
"disabledAt": { "nullable": true, "type": "number" },
1276
"enabledAt": { "nullable": true, "type": "number" }
1277
},
1278
"required": ["price", "batch", "threshold", "hidden"],
1279
"type": "object"
1280
},
1281
"wafOwaspExcessBytes": {
1282
"properties": {
1283
"matrix": {
1284
"properties": {
1285
"defaultUnitPrice": { "type": "string" },
1286
"dimensionPrices": {
1287
"additionalProperties": { "type": "string" },
1288
"type": "object"
1289
}
1290
},
1291
"required": ["defaultUnitPrice", "dimensionPrices"],
1292
"type": "object"
1293
},
1294
"tier": { "type": "number" },
1295
"price": { "type": "number" },
1296
"batch": { "type": "number" },
1297
"threshold": { "type": "number" },
1298
"name": { "type": "string" },
1299
"hidden": { "type": "boolean" },
1300
"disabledAt": { "nullable": true, "type": "number" },
1301
"enabledAt": { "nullable": true, "type": "number" }
1302
},
1303
"required": ["price", "batch", "threshold", "hidden"],
1304
"type": "object"
1305
},
1306
"wafOwaspRequests": {
1307
"properties": {
1308
"matrix": {
1309
"properties": {
1310
"defaultUnitPrice": { "type": "string" },
1311
"dimensionPrices": {
1312
"additionalProperties": { "type": "string" },
1313
"type": "object"
1314
}
1315
},
1316
"required": ["defaultUnitPrice", "dimensionPrices"],
1317
"type": "object"
1318
},
1319
"tier": { "type": "number" },
1320
"price": { "type": "number" },
1321
"batch": { "type": "number" },
1322
"threshold": { "type": "number" },
1323
"name": { "type": "string" },
1324
"hidden": { "type": "boolean" },
1325
"disabledAt": { "nullable": true, "type": "number" },
1326
"enabledAt": { "nullable": true, "type": "number" }
1327
},
1328
"required": ["price", "batch", "threshold", "hidden"],
1329
"type": "object"
1330
},
1331
"webAnalyticsEvent": {
1332
"properties": {
1333
"matrix": {
1334
"properties": {
1335
"defaultUnitPrice": { "type": "string" },
1336
"dimensionPrices": {
1337
"additionalProperties": { "type": "string" },
1338
"type": "object"
1339
}
1340
},
1341
"required": ["defaultUnitPrice", "dimensionPrices"],
1342
"type": "object"
1343
},
1344
"tier": { "type": "number" },
1345
"price": { "type": "number" },
1346
"batch": { "type": "number" },
1347
"threshold": { "type": "number" },
1348
"name": { "type": "string" },
1349
"hidden": { "type": "boolean" },
1350
"disabledAt": { "nullable": true, "type": "number" },
1351
"enabledAt": { "nullable": true, "type": "number" }
1352
},
1353
"required": ["price", "batch", "threshold", "hidden"],
1354
"type": "object"
1355
}
1356
},
1357
"type": "object"
1358
},
1359
"invoiceSettings": {
1360
"properties": { "footer": { "type": "string" } },
1361
"type": "object"
1362
},
1363
"subscriptions": {
1364
"nullable": true,
1365
"items": {
1366
"properties": {
1367
"id": { "type": "string" },
1368
"trial": {
1369
"nullable": true,
1370
"properties": {
1371
"start": { "type": "number" },
1372
"end": { "type": "number" }
1373
},
1374
"required": ["start", "end"],
1375
"type": "object"
1376
},
1377
"period": {
1378
"properties": {
1379
"start": { "type": "number" },
1380
"end": { "type": "number" }
1381
},
1382
"required": ["start", "end"],
1383
"type": "object"
1384
},
1385
"frequency": {
1386
"properties": {
1387
"interval": {
1388
"type": "string",
1389
"enum": ["month", "day", "week", "year"]
1390
},
1391
"intervalCount": { "type": "number" }
1392
},
1393
"required": ["interval", "intervalCount"],
1394
"type": "object"
1395
},
1396
"discount": {
1397
"nullable": true,
1398
"properties": {
1399
"id": { "type": "string" },
1400
"coupon": {
1401
"properties": {
1402
"id": { "type": "string" },
1403
"name": { "nullable": true, "type": "string" },
1404
"amountOff": { "nullable": true, "type": "number" },
1405
"percentageOff": { "nullable": true, "type": "number" },
1406
"durationInMonths": {
1407
"nullable": true,
1408
"type": "number"
1409
},
1410
"duration": {
1411
"type": "string",
1412
"enum": ["forever", "repeating", "once"]
1413
}
1414
},
1415
"required": [
1416
"id",
1417
"name",
1418
"amountOff",
1419
"percentageOff",
1420
"durationInMonths",
1421
"duration"
1422
],
1423
"type": "object"
1424
}
1425
},
1426
"required": ["id", "coupon"],
1427
"type": "object"
1428
},
1429
"items": {
1430
"items": {
1431
"properties": {
1432
"id": { "type": "string" },
1433
"priceId": { "type": "string" },
1434
"productId": { "type": "string" },
1435
"amount": { "type": "number" },
1436
"quantity": { "type": "number" }
1437
},
1438
"required": [
1439
"id",
1440
"priceId",
1441
"productId",
1442
"amount",
1443
"quantity"
1444
],
1445
"type": "object"
1446
},
1447
"type": "array"
1448
}
1449
},
1450
"required": [
1451
"id",
1452
"trial",
1453
"period",
1454
"frequency",
1455
"discount",
1456
"items"
1457
],
1458
"type": "object"
1459
},
1460
"type": "array"
1461
},
1462
"controls": {
1463
"nullable": true,
1464
"properties": {
1465
"analyticsSampleRateInPercent": {
1466
"nullable": true,
1467
"type": "number"
1468
},
1469
"analyticsSpendLimitInDollars": {
1470
"nullable": true,
1471
"type": "number"
1472
}
1473
},
1474
"type": "object"
1475
},
1476
"purchaseOrder": { "nullable": true, "type": "string" },
1477
"status": {
1478
"type": "string",
1479
"enum": ["active", "trialing", "overdue", "expired", "canceled"]
1480
},
1481
"pricingExperiment": { "type": "string", "enum": ["august-2022"] },
1482
"orbMigrationScheduledAt": { "nullable": true, "type": "number" }
1483
},
1484
"required": ["period", "plan"],
1485
"type": "object",
1486
"description": "An object containing billing infomation associated with the User account."
1487
},
1488
"resourceConfig": {
1489
"properties": {
1490
"blobStores": {
1491
"type": "number",
1492
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1493
},
1494
"nodeType": {
1495
"type": "string",
1496
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1497
},
1498
"concurrentBuilds": {
1499
"type": "number",
1500
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1501
},
1502
"awsAccountType": {
1503
"type": "string",
1504
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1505
},
1506
"awsAccountIds": {
1507
"items": { "type": "string" },
1508
"type": "array",
1509
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1510
},
1511
"cfZoneName": {
1512
"type": "string",
1513
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1514
},
1515
"edgeConfigs": {
1516
"type": "number",
1517
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1518
},
1519
"edgeConfigSize": {
1520
"type": "number",
1521
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1522
},
1523
"edgeFunctionMaxSizeBytes": {
1524
"type": "number",
1525
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1526
},
1527
"edgeFunctionExecutionTimeoutMs": {
1528
"type": "number",
1529
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1530
},
1531
"serverlessFunctionDefaultMaxExecutionTime": {
1532
"type": "number",
1533
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1534
},
1535
"kvDatabases": {
1536
"type": "number",
1537
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1538
},
1539
"postgresDatabases": {
1540
"type": "number",
1541
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1542
},
1543
"integrationStores": {
1544
"type": "number",
1545
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1546
},
1547
"cronJobs": {
1548
"type": "number",
1549
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1550
},
1551
"cronJobsPerProject": {
1552
"type": "number",
1553
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1554
}
1555
},
1556
"type": "object",
1557
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1558
},
1559
"stagingPrefix": {
1560
"type": "string",
1561
"description": "Prefix that will be used in the URL of \"Preview\" deployments created by the User account."
1562
},
1563
"activeDashboardViews": {
1564
"items": {
1565
"properties": {
1566
"scopeId": { "type": "string" },
1567
"viewPreference": { "type": "string", "enum": ["list", "cards"] },
1568
"favoritesViewPreference": {
1569
"type": "string",
1570
"enum": ["open", "closed"]
1571
},
1572
"recentsViewPreference": {
1573
"type": "string",
1574
"enum": ["open", "closed"]
1575
}
1576
},
1577
"required": ["scopeId"],
1578
"type": "object",
1579
"description": "set of dashboard view preferences (cards or list) per scopeId"
1580
},
1581
"type": "array",
1582
"description": "set of dashboard view preferences (cards or list) per scopeId"
1583
},
1584
"importFlowGitNamespace": {
1585
"nullable": true,
1586
"oneOf": [{ "type": "string" }, { "type": "number" }]
1587
},
1588
"importFlowGitNamespaceId": {
1589
"nullable": true,
1590
"oneOf": [{ "type": "string" }, { "type": "number" }]
1591
},
1592
"importFlowGitProvider": {
1593
"type": "string",
1594
"enum": ["github", "gitlab", "bitbucket"]
1595
},
1596
"preferredScopesAndGitNamespaces": {
1597
"items": {
1598
"properties": {
1599
"scopeId": { "type": "string" },
1600
"gitNamespaceId": {
1601
"nullable": true,
1602
"oneOf": [{ "type": "string" }, { "type": "number" }]
1603
}
1604
},
1605
"required": ["scopeId", "gitNamespaceId"],
1606
"type": "object"
1607
},
1608
"type": "array"
1609
},
1610
"dismissedToasts": {
1611
"items": {
1612
"properties": {
1613
"name": { "type": "string" },
1614
"dismissals": {
1615
"items": {
1616
"properties": {
1617
"scopeId": { "type": "string" },
1618
"createdAt": { "type": "number" }
1619
},
1620
"required": ["scopeId", "createdAt"],
1621
"type": "object"
1622
},
1623
"type": "array"
1624
}
1625
},
1626
"required": ["name", "dismissals"],
1627
"type": "object",
1628
"description": "A record of when, under a certain scopeId, a toast was dismissed"
1629
},
1630
"type": "array",
1631
"description": "A record of when, under a certain scopeId, a toast was dismissed"
1632
},
1633
"favoriteProjectsAndSpaces": {
1634
"items": {
1635
"oneOf": [
1636
{
1637
"properties": {
1638
"projectId": { "type": "string" },
1639
"scopeSlug": { "type": "string" },
1640
"scopeId": { "type": "string" }
1641
},
1642
"required": ["projectId", "scopeSlug", "scopeId"],
1643
"type": "object",
1644
"description": "A list of projects and spaces across teams that a user has marked as a favorite."
1645
},
1646
{
1647
"properties": {
1648
"spaceId": { "type": "string" },
1649
"scopeSlug": { "type": "string" },
1650
"scopeId": { "type": "string" }
1651
},
1652
"required": ["spaceId", "scopeSlug", "scopeId"],
1653
"type": "object",
1654
"description": "A list of projects and spaces across teams that a user has marked as a favorite."
1655
}
1656
]
1657
},
1658
"type": "array",
1659
"description": "A list of projects and spaces across teams that a user has marked as a favorite."
1660
},
1661
"hasTrialAvailable": {
1662
"type": "boolean",
1663
"description": "Whether the user has a trial available for a paid plan subscription."
1664
},
1665
"remoteCaching": {
1666
"properties": { "enabled": { "type": "boolean" } },
1667
"type": "object",
1668
"description": "remote caching settings"
1669
},
1670
"dataCache": {
1671
"properties": { "excessBillingEnabled": { "type": "boolean" } },
1672
"type": "object",
1673
"description": "data cache settings"
1674
},
1675
"featureBlocks": {
1676
"properties": {
1677
"webAnalytics": {
1678
"properties": {
1679
"blockedFrom": { "type": "number" },
1680
"blockedUntil": { "type": "number" },
1681
"isCurrentlyBlocked": { "type": "boolean" }
1682
},
1683
"required": ["isCurrentlyBlocked"],
1684
"type": "object"
1685
}
1686
},
1687
"type": "object",
1688
"description": "Feature blocks for the user"
1689
},
1690
"northstar": {
1691
"properties": {
1692
"migration": {
1693
"properties": {
1694
"teamId": { "type": "string" },
1695
"status": {
1696
"type": "string",
1697
"enum": ["migrating", "completed", "failed", "will-migrate"],
1698
"description": "- `will-migrate`: Show dashboard toast saying \"your account will be migrated soon\" - `migrating`: Show dashboard toast saying \"your account is currently migrating to `teamId`\" - `completed`: Show dashboard toast saying \"your account has been migrated to `teamId`\" - `failed`: Show dashboard toast saying \"your account migration has failed `teamId`\""
1699
}
1700
},
1701
"required": ["status"],
1702
"type": "object"
1703
}
1704
},
1705
"type": "object",
1706
"description": "Northstar migration specific data"
1707
},
1708
"northstarMigration": {
1709
"properties": {
1710
"teamId": {
1711
"type": "string",
1712
"description": "The ID of the team we created for this user."
1713
},
1714
"projects": {
1715
"type": "number",
1716
"description": "The number of projects migrated for this user."
1717
},
1718
"stores": {
1719
"type": "number",
1720
"description": "The number of stores migrated for this user."
1721
},
1722
"integrationConfigurations": {
1723
"type": "number",
1724
"description": "The number of integration configurations migrated for this user."
1725
},
1726
"integrationClients": {
1727
"type": "number",
1728
"description": "The number of integration clients migrated for this user."
1729
},
1730
"startTime": {
1731
"type": "number",
1732
"description": "The migration start time timestamp for this user."
1733
},
1734
"endTime": {
1735
"type": "number",
1736
"description": "The migration end time timestamp for this user."
1737
}
1738
},
1739
"required": [
1740
"teamId",
1741
"projects",
1742
"stores",
1743
"integrationConfigurations",
1744
"integrationClients",
1745
"startTime",
1746
"endTime"
1747
],
1748
"type": "object"
1749
},
1750
"id": {
1751
"type": "string",
1752
"description": "The User's unique identifier.",
1753
"example": "AEIIDYVk59zbFF2Sxfyxxmua"
1754
},
1755
"email": {
1756
"type": "string",
1757
"description": "Email address associated with the User account.",
1758
"example": "me@example.com"
1759
},
1760
"name": {
1761
"nullable": true,
1762
"type": "string",
1763
"description": "Name associated with the User account, or `null` if none has been provided.",
1764
"example": "John Doe"
1765
},
1766
"username": {
1767
"type": "string",
1768
"description": "Unique username associated with the User account.",
1769
"example": "jdoe"
1770
},
1771
"avatar": {
1772
"nullable": true,
1773
"type": "string",
1774
"description": "SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image.",
1775
"example": "22cb30c85ff45ac4c72de8981500006b28114aa1"
1776
},
1777
"defaultTeamId": {
1778
"nullable": true,
1779
"type": "string",
1780
"description": "The user's default team. Only applies if the user's `version` is `'northstar'`."
1781
},
1782
"version": {
1783
"nullable": true,
1784
"type": "string",
1785
"enum": ["northstar"],
1786
"description": "The user's version. Will either be unset or `northstar`."
1787
}
1788
},
1789
"required": [
1790
"createdAt",
1791
"softBlock",
1792
"billing",
1793
"resourceConfig",
1794
"stagingPrefix",
1795
"hasTrialAvailable",
1796
"id",
1797
"email",
1798
"name",
1799
"username",
1800
"avatar",
1801
"defaultTeamId",
1802
"version"
1803
],
1804
"type": "object",
1805
"description": "Data for the currently authenticated User."
1806
}

AuthUserLimited

1
{
2
"properties": {
3
"limited": {
4
"type": "boolean",
5
"description": "Property indicating that this User data contains only limited information, due to the authentication token missing privileges to read the full User data. Re-login with email, GitHub, GitLab or Bitbucket in order to upgrade the authentication token with the necessary privileges."
6
},
7
"id": {
8
"type": "string",
9
"description": "The User's unique identifier.",
10
"example": "AEIIDYVk59zbFF2Sxfyxxmua"
11
},
12
"email": {
13
"type": "string",
14
"description": "Email address associated with the User account.",
15
"example": "me@example.com"
16
},
17
"name": {
18
"nullable": true,
19
"type": "string",
20
"description": "Name associated with the User account, or `null` if none has been provided.",
21
"example": "John Doe"
22
},
23
"username": {
24
"type": "string",
25
"description": "Unique username associated with the User account.",
26
"example": "jdoe"
27
},
28
"avatar": {
29
"nullable": true,
30
"type": "string",
31
"description": "SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image.",
32
"example": "22cb30c85ff45ac4c72de8981500006b28114aa1"
33
},
34
"defaultTeamId": {
35
"nullable": true,
36
"type": "string",
37
"description": "The user's default team. Only applies if the user's `version` is `'northstar'`."
38
},
39
"version": {
40
"nullable": true,
41
"type": "string",
42
"enum": ["northstar"],
43
"description": "The user's version. Will either be unset or `northstar`."
44
}
45
},
46
"required": [
47
"limited",
48
"id",
49
"email",
50
"name",
51
"username",
52
"avatar",
53
"defaultTeamId",
54
"version"
55
],
56
"type": "object",
57
"description": "A limited form of data for the currently authenticated User, due to the authentication token missing privileges to read the full User data."
58
}

EdgeConfigItem

1
{
2
"properties": {
3
"key": { "type": "string" },
4
"value": { "$ref": "#/components/schemas/EdgeConfigItemValue" },
5
"description": { "type": "string" },
6
"edgeConfigId": { "type": "string" },
7
"createdAt": { "type": "number" },
8
"updatedAt": { "type": "number" }
9
},
10
"required": ["key", "value", "edgeConfigId", "createdAt", "updatedAt"],
11
"type": "object",
12
"description": "The EdgeConfig."
13
}

EdgeConfigItemValue

1
{
2
"nullable": true,
3
"oneOf": [
4
{ "type": "string" },
5
{ "type": "number" },
6
{ "type": "boolean" },
7
{
8
"additionalProperties": {
9
"$ref": "#/components/schemas/EdgeConfigItemValue"
10
},
11
"type": "object"
12
},
13
{
14
"items": { "$ref": "#/components/schemas/EdgeConfigItemValue" },
15
"type": "array"
16
}
17
]
18
}

EdgeConfigToken

1
{
2
"properties": {
3
"token": { "type": "string" },
4
"label": { "type": "string" },
5
"id": {
6
"type": "string",
7
"description": "This is not the token itself, but rather an id to identify the token by"
8
},
9
"edgeConfigId": { "type": "string" },
10
"createdAt": { "type": "number" }
11
},
12
"required": ["token", "label", "id", "edgeConfigId", "createdAt"],
13
"type": "object",
14
"description": "The EdgeConfig."
15
}

FileTree

1
{
2
"properties": {
3
"name": {
4
"type": "string",
5
"description": "The name of the file tree entry",
6
"example": "my-file.json"
7
},
8
"type": {
9
"type": "string",
10
"enum": [
11
"directory",
12
"file",
13
"symlink",
14
"lambda",
15
"middleware",
16
"invalid"
17
],
18
"description": "String indicating the type of file tree entry.",
19
"example": "file"
20
},
21
"uid": {
22
"type": "string",
23
"description": "The unique identifier of the file (only valid for the `file` type)",
24
"example": "2d4aad419917f15b1146e9e03ddc9bb31747e4d0"
25
},
26
"children": {
27
"items": { "$ref": "#/components/schemas/FileTree" },
28
"type": "array",
29
"description": "The list of children files of the directory (only valid for the `directory` type)"
30
},
31
"contentType": {
32
"type": "string",
33
"description": "The content-type of the file (only valid for the `file` type)",
34
"example": "application/json"
35
},
36
"mode": {
37
"type": "number",
38
"description": "The file \"mode\" indicating file type and permissions."
39
},
40
"symlink": {
41
"type": "string",
42
"description": "Not currently used. See `file-list-to-tree.ts`."
43
}
44
},
45
"required": ["name", "type", "mode"],
46
"type": "object",
47
"description": "A deployment file tree entry"
48
}

Pagination

1
{
2
"properties": {
3
"count": {
4
"type": "number",
5
"description": "Amount of items in the current page.",
6
"example": 20
7
},
8
"next": {
9
"nullable": true,
10
"type": "number",
11
"description": "Timestamp that must be used to request the next page.",
12
"example": 1540095775951
13
},
14
"prev": {
15
"nullable": true,
16
"type": "number",
17
"description": "Timestamp that must be used to request the previous page.",
18
"example": 1540095775951
19
}
20
},
21
"required": ["count", "next", "prev"],
22
"type": "object",
23
"description": "This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data."
24
}

Team

1
{ "type": "object", "description": "Data representing a Team." }

TeamLimited

1
{
2
"properties": {
3
"limited": {
4
"type": "boolean",
5
"description": "Property indicating that this Team data contains only limited information, due to the authentication token missing privileges to read the full Team data. Re-login with the Team's configured SAML Single Sign-On provider in order to upgrade the authentication token with the necessary privileges."
6
},
7
"saml": {
8
"properties": {
9
"connection": {
10
"properties": {
11
"type": {
12
"type": "string",
13
"description": "The Identity Provider \"type\", for example Okta.",
14
"example": "OktaSAML"
15
},
16
"status": {
17
"type": "string",
18
"description": "Current status of the connection.",
19
"example": "linked"
20
},
21
"state": {
22
"type": "string",
23
"description": "Current state of the connection.",
24
"example": "active"
25
},
26
"connectedAt": {
27
"type": "number",
28
"description": "Timestamp (in milliseconds) of when the configuration was connected.",
29
"example": 1611796915677
30
},
31
"lastReceivedWebhookEvent": {
32
"type": "number",
33
"description": "Timestamp (in milliseconds) of when the last webhook event was received from WorkOS.",
34
"example": 1611796915677
35
}
36
},
37
"required": ["type", "status", "state", "connectedAt"],
38
"type": "object",
39
"description": "Information for the SAML Single Sign-On configuration."
40
},
41
"directory": {
42
"properties": {
43
"type": {
44
"type": "string",
45
"description": "The Identity Provider \"type\", for example Okta.",
46
"example": "OktaSAML"
47
},
48
"status": {
49
"type": "string",
50
"description": "Current status of the connection.",
51
"example": "linked"
52
},
53
"state": {
54
"type": "string",
55
"description": "Current state of the connection.",
56
"example": "active"
57
},
58
"connectedAt": {
59
"type": "number",
60
"description": "Timestamp (in milliseconds) of when the configuration was connected.",
61
"example": 1611796915677
62
},
63
"lastReceivedWebhookEvent": {
64
"type": "number",
65
"description": "Timestamp (in milliseconds) of when the last webhook event was received from WorkOS.",
66
"example": 1611796915677
67
}
68
},
69
"required": ["type", "status", "state", "connectedAt"],
70
"type": "object",
71
"description": "Information for the SAML Single Sign-On configuration."
72
},
73
"enforced": {
74
"type": "boolean",
75
"description": "When `true`, interactions with the Team **must** be done with an authentication token that has been authenticated with the Team's SAML Single Sign-On provider."
76
}
77
},
78
"required": ["enforced"],
79
"type": "object",
80
"description": "When \"Single Sign-On (SAML)\" is configured, this object contains information that allows the client-side to identify whether or not this Team has SAML enforced."
81
},
82
"id": {
83
"type": "string",
84
"description": "The Team's unique identifier.",
85
"example": "team_nllPyCtREAqxxdyFKbbMDlxd"
86
},
87
"slug": {
88
"type": "string",
89
"description": "The Team's slug, which is unique across the Vercel platform.",
90
"example": "my-team"
91
},
92
"name": {
93
"nullable": true,
94
"type": "string",
95
"description": "Name associated with the Team account, or `null` if none has been provided.",
96
"example": "My Team"
97
},
98
"avatar": {
99
"nullable": true,
100
"type": "string",
101
"description": "The ID of the file used as avatar for this Team.",
102
"example": "6eb07268bcfadd309905ffb1579354084c24655c"
103
},
104
"membership": {
105
"oneOf": [
106
{
107
"properties": {
108
"confirmed": { "type": "boolean" },
109
"confirmedAt": { "type": "number" },
110
"accessRequestedAt": { "type": "number" },
111
"role": {
112
"type": "string",
113
"enum": [
114
"OWNER",
115
"MEMBER",
116
"DEVELOPER",
117
"BILLING",
118
"VIEWER",
119
"CONTRIBUTOR"
120
]
121
},
122
"teamId": { "type": "string" },
123
"uid": { "type": "string" },
124
"createdAt": { "type": "number" },
125
"created": { "type": "number" },
126
"joinedFrom": {
127
"properties": {
128
"origin": {
129
"type": "string",
130
"enum": [
131
"link",
132
"saml",
133
"mail",
134
"import",
135
"teams",
136
"github",
137
"gitlab",
138
"bitbucket",
139
"dsync",
140
"feedback",
141
"organization-teams"
142
]
143
},
144
"commitId": { "type": "string" },
145
"repoId": { "type": "string" },
146
"repoPath": { "type": "string" },
147
"gitUserId": {
148
"oneOf": [{ "type": "string" }, { "type": "number" }]
149
},
150
"gitUserLogin": { "type": "string" },
151
"ssoUserId": { "type": "string" },
152
"ssoConnectedAt": { "type": "number" },
153
"idpUserId": { "type": "string" },
154
"dsyncUserId": { "type": "string" },
155
"dsyncConnectedAt": { "type": "number" }
156
},
157
"required": ["origin"],
158
"type": "object"
159
}
160
},
161
"required": [
162
"confirmed",
163
"confirmedAt",
164
"role",
165
"uid",
166
"createdAt",
167
"created"
168
],
169
"type": "object",
170
"description": "The membership of the authenticated User in relation to the Team."
171
},
172
{
173
"properties": {
174
"confirmed": { "type": "boolean" },
175
"confirmedAt": { "type": "number" },
176
"accessRequestedAt": { "type": "number" },
177
"role": {
178
"type": "string",
179
"enum": [
180
"OWNER",
181
"MEMBER",
182
"DEVELOPER",
183
"BILLING",
184
"VIEWER",
185
"CONTRIBUTOR"
186
]
187
},
188
"teamId": { "type": "string" },
189
"uid": { "type": "string" },
190
"createdAt": { "type": "number" },
191
"created": { "type": "number" },
192
"joinedFrom": {
193
"properties": {
194
"origin": {
195
"type": "string",
196
"enum": [
197
"link",
198
"saml",
199
"mail",
200
"import",
201
"teams",
202
"github",
203
"gitlab",
204
"bitbucket",
205
"dsync",
206
"feedback",
207
"organization-teams"
208
]
209
},
210
"commitId": { "type": "string" },
211
"repoId": { "type": "string" },
212
"repoPath": { "type": "string" },
213
"gitUserId": {
214
"oneOf": [{ "type": "string" }, { "type": "number" }]
215
},
216
"gitUserLogin": { "type": "string" },
217
"ssoUserId": { "type": "string" },
218
"ssoConnectedAt": { "type": "number" },
219
"idpUserId": { "type": "string" },
220
"dsyncUserId": { "type": "string" },
221
"dsyncConnectedAt": { "type": "number" }
222
},
223
"required": ["origin"],
224
"type": "object"
225
}
226
},
227
"required": [
228
"confirmed",
229
"accessRequestedAt",
230
"role",
231
"uid",
232
"createdAt",
233
"created"
234
],
235
"type": "object",
236
"description": "The membership of the authenticated User in relation to the Team."
237
}
238
]
239
},
240
"created": {
241
"type": "string",
242
"description": "Will remain undocumented. Remove in v3 API."
243
},
244
"createdAt": {
245
"type": "number",
246
"description": "UNIX timestamp (in milliseconds) when the Team was created.",
247
"example": 1630748523395
248
}
249
},
250
"required": [
251
"limited",
252
"id",
253
"slug",
254
"name",
255
"avatar",
256
"membership",
257
"created",
258
"createdAt"
259
],
260
"type": "object",
261
"description": "A limited form of data representing a Team, due to the authentication token missing privileges to read the full Team data."
262
}

UserEvent

1
{
2
"properties": {
3
"id": {
4
"type": "string",
5
"description": "The unique identifier of the Event.",
6
"example": "uev_bfmMjiMnXfnPbT97dGdpJbCN"
7
},
8
"text": {
9
"type": "string",
10
"description": "The human-readable text of the Event.",
11
"example": "You logged in via GitHub"
12
},
13
"entities": {
14
"items": {
15
"properties": {
16
"type": {
17
"type": "string",
18
"enum": [
19
"author",
20
"bitbucket_login",
21
"bold",
22
"deployment_host",
23
"dns_record",
24
"git_link",
25
"github_login",
26
"gitlab_login",
27
"hook_name",
28
"integration",
29
"edge-config",
30
"link",
31
"project_name",
32
"scaling_rules",
33
"env_var_name",
34
"target",
35
"store",
36
"system"
37
],
38
"description": "The type of entity.",
39
"example": "author"
40
},
41
"start": {
42
"type": "number",
43
"description": "The index of where the entity begins within the `text` (inclusive).",
44
"example": 0
45
},
46
"end": {
47
"type": "number",
48
"description": "The index of where the entity ends within the `text` (non-inclusive).",
49
"example": 3
50
}
51
},
52
"required": ["type", "start", "end"],
53
"type": "object",
54
"description": "A list of \"entities\" within the event `text`. Useful for enhancing the displayed text with additional styling and links."
55
},
56
"type": "array",
57
"description": "A list of \"entities\" within the event `text`. Useful for enhancing the displayed text with additional styling and links."
58
},
59
"createdAt": {
60
"type": "number",
61
"description": "Timestamp (in milliseconds) of when the event was generated.",
62
"example": 1632859321020
63
},
64
"user": {
65
"properties": {
66
"avatar": { "type": "string" },
67
"email": { "type": "string" },
68
"slug": { "type": "string" },
69
"uid": { "type": "string" },
70
"username": { "type": "string" }
71
},
72
"required": ["avatar", "email", "uid", "username"],
73
"type": "object",
74
"description": "Metadata for the User who generated the event."
75
},
76
"userId": {
77
"type": "string",
78
"description": "The unique identifier of the User who generated the event.",
79
"example": "zTuNVUXEAvvnNN3IaqinkyMw"
80
}
81
},
82
"required": ["id", "text", "entities", "createdAt", "userId"],
83
"type": "object",
84
"description": "Array of events generated by the User."
85
}
Last updated on May 11, 2024